<?php
/**
 * A default client pool class
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
class DefaultClientPool extends BasePool implements PoolableClient {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates an instance of this class
	 *
	 * @param	$listenerInstance	A Listenable instance
	 * @return	$poolInstance		An instance a Poolable class
	 */
	public final static function createDefaultClientPool (Listenable $listenerInstance) {
		// Get new instance
		$poolInstance = new DefaultClientPool();

		// Set the application instance
		$poolInstance->setListenerInstance($listenerInstance);

		// Return the prepared instance
		return $poolInstance;
	}

	/**
	 * Adds a socket resource to the client pool
	 *
	 * @param	$socketResource		A valid (must be!) socket resource
	 * @return	void
	 * @throws	InvalidSocketException	If the given resource is invalid or errorous
	 */
	public function addClient ($socketResource) {
		// Is it a valid resource?
		if (!is_resource($socketResource)) {
			// Throw an exception
			throw new InvalidSocketException(array($this, gettype($socketResource), 0, 'invalid'), BaseListener::EXCEPTION_INVALID_SOCKET);
		} // END - if

		// Get error code
		$errorCode = socket_last_error($socketResource);

		// Is it without any errors?
		if ($errorCode > 0) {
			// Throw an exception again
			throw new InvalidSocketException(array($this, gettype($socketResource), $errorCode, socket_strerror($errorCode)), BaseListener::EXCEPTION_INVALID_SOCKET);
		} // END - if

		// Add it finally to the pool
		$this->addPoolEntry($socketResource);
	}
}

//
?>