3 * A default peer pool class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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, gettype($socketResource), 0, 'invalid'), BaseListener::EXCEPTION_INVALID_SOCKET);
67 $errorCode = socket_last_error($socketResource);
69 // Is it without any errors?
72 $errorMessage = socket_strerror($errorCode);
74 // Shutdown this socket
75 $this->getListenerInstance()->shutdownSocket($socketResource);
78 throw new InvalidSocketException(array($this, gettype($socketResource), $errorCode, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
83 * Adds a socket resource to the peer pool
85 * @param $socketResource A valid (must be!) socket resource
87 * @throws InvalidSocketException If the given resource is invalid or errorous
89 public function addPeer ($socketResource) {
90 // Validate the socket
91 $this->validateSocket($socketResource);
93 // Default is this peer's IP
94 $peerName = '0.0.0.0';
96 // The socket resource should not match server socket
97 if ($socketResource != $this->getListenerInstance()->getSocketResource()) {
98 // Try to determine the peer's IP number
99 if (!socket_getpeername($socketResource, $peerName)) {
101 $lastError = socket_last_error($socketResource);
104 throw new InvalidSocketException(array($this, gettype($socketResource), $lastError, socket_strerror($lastError)), BaseListener::EXCEPTION_INVALID_SOCKET);
107 // Server sockets won't work with socket_getpeername()
108 $this->debugOutput('POOL: Socket resource is server socket (' . $socketResource . '). This is not a bug.');
111 // Output error message
112 $this->debugOutput('POOL: Adding peer ' . $peerName . ', socketResource=' . $socketResource);
114 // Add it finally to the pool
115 $this->addPoolEntry($socketResource);
119 * Getter for array of all socket resources
121 * @return $sockets An array with all sockets
123 public final function getAllSockets () {
125 $sockets = $this->getArrayFromList('pool');
132 * "Getter" for a valid socket resource from given packae data.
134 * @param $packageData Raw package data
135 * @return $socketResource Socket resource
137 public function getSocketFromPackageData (array $packageData) {
138 // Default is no socket
139 $socketResource = false;
141 // Get all sockets and check them, skip the server socket
142 foreach ($this->getAllSockets() as $socket) {
143 // Is this a server socket?
144 if ($socket === $this->getListenerInstance()->getSocketResource()) {
149 // @TODO Check for IP
150 $this->debugBackTrace(__METHOD__ . ':'.print_r($packageData, true));
153 // Return the determined socket resource
154 return $socketResource;