3 * A Socket Container class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 $protocolInstance A ProtocolHandler instance
40 * @param $packageData Raw package data
41 * @return $containerInstance An instance of this Container class
43 public static final function createSocketContainer ($socketResource, ProtocolHandler $protocolInstance = 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_SIGNATURE]);
52 //* NOISY-DEBUG: */ $containerInstance->debugOutput(__METHOD__ . ':socketResource=' . $socketResource . ',packageData='.print_r($packageData,true));
54 // Set the resource ...
55 $containerInstance->setSocketResource($socketResource);
57 // ..., protocol instance ...
58 $containerInstance->setProtocolInstance($protocolInstance);
60 // ... and package data
61 $containerInstance->setPackageData($packageData);
63 // Return the prepared instance
64 return $containerInstance;
68 * Checks whether the given address (IP) matches with the one from the socket resource
70 * @param $addressPort The address:port (IP to check
71 * @return $matches Whether $address matches with the one from socket resource
73 public final function ifAddressMatches ($addressPort) {
74 // Get current package data
75 $packageData = $this->getPackageData();
78 //* NOISY-DEBUG: */ $this->debugOutput('SOCKET-CONTAINER: addressPort=' . $addressPort . ',packageData=' . print_r($packageData, true));
80 // So, does both match?
81 $matches = ((isset($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT])) && ($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT] === $addressPort));
88 * Checks whether the given socket matches with stored
90 * @param $addressPort The address:port (IP to check
91 * @return $matches Whether given socket matches
93 public final function ifSocketResourceMatches ($socketResource) {
95 /* NOISY-DEBUG: */ $this->debugOutput('SOCKET-CONTAINER: socketResource[' . gettype($socketResource) . ']=' .$socketResource . ',storedResource[' . gettype($this->getSocketResource()) . ']=' . $this->getSocketResource());
97 // So, does both match?
98 $matches = ((is_resource($socketResource)) && ($socketResource === $this->getSocketResource()));