3 * A Socket Container class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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, array $packageData) {
45 $containerInstance = new SocketContainer();
47 // Set the resource ...
48 $containerInstance->setSocketResource($socketResource);
50 // ..., protocol instance ...
51 $containerInstance->setProtocolInstance($protocolInstance);
53 // ... and package data
54 $containerInstance->setPackageData($packageData);
56 // Return the prepared instance
57 return $containerInstance;
61 * Checks wether the given address (IP) matches with the one from the socket resource
63 * @param $addressPort The address:port (IP to check
64 * @return $matches Wether $address matches with the one from socket resource
66 public final function ifAddressMatches ($addressPort) {
67 // Get current package data
68 $data = $this->getPackageData();
70 // So, does both match?
71 $matches = ((isset($data['recipient'])) && ($data['recipient'] === $addressPort));