3 * A Socket Container class
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class SocketContainer extends BaseContainer implements Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this Container class and prepares it for usage
38 * @param $socketResource A valid socket resource
39 * @param $infoInstance An instance of a ShareableInfo class
40 * @param $packageData Raw package data
41 * @return $containerInstance An instance of this Container class
43 public static final function createSocketContainer ($socketResource, ShareableInfo $infoInstance = NULL, array $packageData = array()) {
45 $containerInstance = new SocketContainer();
47 // Remove unneeded entries
48 unset($packageData[NetworkPackage::PACKAGE_DATA_CONTENT]);
49 unset($packageData[NetworkPackage::PACKAGE_DATA_HASH]);
52 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']:socketResource=' . $socketResource . ',packageData='.print_r($packageData, TRUE));
54 // Is the info instance set?
55 if ($infoInstance instanceof ShareableInfo) {
56 // Get listener/helper from info class
57 $listenerInstance = $infoInstance->getListenerInstance();
58 $helperInstance = $infoInstance->getHelperInstance();
61 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: listenerInstance[]=' . gettype($listenerInstance));
63 // Is there a listener instance set?
64 if ($listenerInstance instanceof Listenable) {
66 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: Setting listenerInstance=' . $listenerInstance->__toString() . ' ...');
68 // Set it here for later usage
69 $containerInstance->setListenerInstance($listenerInstance);
70 } elseif ($helperInstance instanceof ConnectionHelper) {
72 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: Setting helperInstance=' . $helperInstance->__toString() . ' ...');
74 // Set it here for later usage
75 $containerInstance->setHelperInstance($helperInstance);
79 // Set the resource ...
80 $containerInstance->setSocketResource($socketResource);
82 // ... and package data
83 $containerInstance->setPackageData($packageData);
85 // Return the prepared instance
86 return $containerInstance;
90 * Checks whether the given Universal Node Locator matches with the one from package data
92 * @param $unl A Universal Node Locator
93 * @return $matches Whether $address matches with the one from package data
95 public final function ifAddressMatches ($unl) {
96 // Get current package data
97 $packageData = $this->getPackageData();
100 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: unl=' . $unl . ',packageData=' . print_r($packageData, TRUE));
102 // So, does both match?
103 $matches = ((isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT])) && ($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] === $unl));
110 * Checks whether the given socket matches with stored
112 * @param $socketResource A valid socket resource
113 * @return $matches Whether given socket matches
115 public final function ifSocketResourceMatches ($socketResource) {
117 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('SOCKET-CONTAINER[' . __METHOD__ . ':' . __LINE__ . ']: socketResource[' . gettype($socketResource) . ']=' .$socketResource . ',storedResource[' . gettype($this->getSocketResource()) . ']=' . $this->getSocketResource());
119 // So, does both match?
120 $matches = ((is_resource($socketResource)) && ($socketResource === $this->getSocketResource()));