3 * A default client pool class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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 DefaultClientPool extends BasePool implements PoolableClient {
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 final static function createDefaultClientPool (Listenable $listenerInstance) {
43 $poolInstance = new DefaultClientPool();
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
58 private function validateSocket ($socketResource) {
59 // Is it a valid resource?
60 if (!is_resource($socketResource)) {
62 throw new InvalidSocketException(array($this, gettype($socketResource), 0, 'invalid'), BaseListener::EXCEPTION_INVALID_SOCKET);
66 $errorCode = socket_last_error($socketResource);
68 // Is it without any errors?
71 $errorMessage = socket_strerror($errorCode);
73 // Shutdown this socket
74 $this->getListenerInstance()->shutdownSocket($socketResource);
77 throw new InvalidSocketException(array($this, gettype($socketResource), $errorCode, $errorMessage), BaseListener::EXCEPTION_INVALID_SOCKET);
82 * Adds a socket resource to the client pool
84 * @param $socketResource A valid (must be!) socket resource
86 * @throws InvalidSocketException If the given resource is invalid or errorous
88 public function addClient ($socketResource) {
89 // Validate the socket
90 $this->validateSocket($socketResource);
92 // Output error message
93 $this->debugOutput('POOL: Adding client ' . $socketResource);
95 // Add it finally to the pool
96 $this->addPoolEntry($socketResource);
100 * Getter for array of all socket resources
102 * @return $sockets An array with all sockets
104 public final function getAllSockets () {
106 $sockets = $this->getArrayFromList('generic');