3 * A default peer pool class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub 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 DefaultPeerPool extends BasePool implements PoolablePeer {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @param $listenerInstance A Listenable instance
39 * @return $poolInstance An instance a Poolable class
41 public static final function createDefaultPeerPool (Listenable $listenerInstance) {
43 $poolInstance = new DefaultPeerPool();
45 // Set the application instance
46 $poolInstance->setListenerInstance($listenerInstance);
48 // Return the prepared instance
53 * Validates given socket
55 * @param $socketResource A valid socket resource
57 * @throws InvalidSocketException If the given socket has an error
59 private function validateSocket ($socketResource) {
60 // Is it a valid resource?
61 if (!is_resource($socketResource)) {
63 throw new InvalidSocketException(array($this, $socketResource), BaseListener::EXCEPTION_INVALID_SOCKET);
67 $errorCode = socket_last_error($socketResource);
69 // Is it without any errors?
71 // Handle the socket error with a faked recipientData array
72 $this->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
75 $errorMessage = socket_strerror($errorCode);
77 // Shutdown this socket
78 $this->getListenerInstance()->shutdownSocket($socketResource);
81 throw new InvalidSocketException(array($this, $socketResource, $errorCode, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
87 * Adds a socket resource to the peer pool
89 * @param $socketResource A valid (must be!) socket resource
91 * @throws InvalidSocketException If the given resource is invalid or errorous
93 public function addPeer ($socketResource) {
94 // Validate the socket
95 $this->validateSocket($socketResource);
97 // Default is this peer's IP
98 $peerName = '0.0.0.0';
100 // The socket resource should not match server socket
101 if ($socketResource != $this->getListenerInstance()->getSocketResource()) {
102 // Try to determine the peer's IP number
103 if (!socket_getpeername($socketResource, $peerName)) {
104 // Handle the socket error with a faked recipientData array
105 $this->handleSocketError(__METHOD__, __LINE__, $socketResource, array('0.0.0.0', '0'));
108 $lastError = socket_last_error($socketResource);
111 throw new InvalidSocketException(array($this, $socketResource, $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
115 // Server sockets won't work with socket_getpeername()
116 $this->debugOutput('POOL: Socket resource is server socket (' . $socketResource . '). This is not a bug.');
120 $this->debugOutput('POOL: Adding peer ' . $peerName . ',socketResource=' . $socketResource);
122 // Create the fake array
123 $packageData = array(
124 NetworkPackage::PACKAGE_DATA_SENDER => $peerName . ':0',
125 NetworkPackage::PACKAGE_DATA_RECIPIENT => $this->getSessionId(),
126 NetworkPackage::PACKAGE_DATA_PROTOCOL => $this->getListenerInstance()->getProtocol(),
127 NetworkPackage::PACKAGE_DATA_STATUS => NetworkPackage::PACKAGE_STATUS_FAKED
130 // Get a socket registry
131 $registryInstance = SocketRegistryFactory::createSocketRegistryInstance();
133 // Register the socket with the registry and with a half-fake array
134 $registryInstance->registerSocket($this->getListenerInstane(), $socketResource, $packageData);
136 // Add it finally to the pool
137 $this->addPoolEntry($socketResource);
141 * Getter for array of all socket resources
143 * @return $sockets An array with all sockets
145 public final function getAllSockets () {
147 $sockets = $this->getArrayFromList('pool');
154 * "Getter" for a valid socket resource from given packae data.
156 * @param $packageData Raw package data
157 * @return $socketResource Socket resource
159 public function getSocketFromPackageData (array $packageData) {
160 // Default is no socket
161 $socketResource = false;
163 // Temporary resolve recipient field
164 $recipientIpArray = explode(':', HubTools::resolveSessionId($packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT], $packageData[NetworkPackage::PACKAGE_DATA_PROTOCOL]));
166 // Make sure it is a valid ip:port array (2 elements)
167 assert(count($recipientIpArray) == 2);
170 /* NOISY-DEBUG: */ $this->debugOutput('POOL: Checking ' . count($this->getAllSockets()) . ' socket(s), recipientIpArray[0]=' . $recipientIpArray[0] . ' ...');
172 // Get all sockets and check them, skip the server socket
173 foreach ($this->getAllSockets() as $socket) {
174 // Is this a server socket?
175 if ($socket === $this->getListenerInstance()->getSocketResource()) {
176 // Skip 'server' sockets (local socket)
177 /* NOISY-DEBUG: */ $this->debugOutput('POOL: Skipping local socket ' . $socket . ' ...');
181 // Try to get the "peer"'s name
182 if (!socket_getpeername($socket, $peerIp)) {
183 // Handle the socket error with given package data
184 $this->handleSocketError(__METHOD__, __LINE__, $socket, explode(':', $packageData[NetworkPackage::PACKAGE_DATA_RECIPIENT]));
187 // If the "peer" IP and recipient is same, use it
188 if ($peerIp == $recipientIpArray[0]) {
189 // IPs match, so take the socket and quit this loop
190 $socketResource = $socket;
193 /* NOISY-DEBUG: */ $this->debugOutput('POOL: peerIp=' . $peerIp . ' matches with recipient IP address. Taking socket=' . $socket);
198 // Return the determined socket resource
199 /* NOISY-DEBUG: */ $this->debugOutput('POOL: socketResource[' . gettype($socketResource) . ']=' . $socketResource);
200 return $socketResource;