*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class BasePool extends BaseHubSystem implements Visitable {
+ /**
+ * Socket array elements
+ */
+ const SOCKET_ARRAY_RESOURCE = 'resource';
+ const SOCKET_ARRAY_CONN_TYPE = 'connection_type';
+
/**
* A list of pool entries
*/
private $poolEntriesInstance = NULL;
+ /**
+ * An array with all valid connection types
+ */
+ private $connectionTypes = array();
+
/**
* Protected constructor
*
// Init the pool entries
$this->poolEntriesInstance = ObjectFactory::createObjectByConfiguredName('pool_entries_list_class');
+
+ // Init array of connection types
+ $this->connectionTypes = array(
+ BaseConnectionHelper::CONNECTION_TYPE_INCOMING,
+ BaseConnectionHelper::CONNECTION_TYPE_OUTGOING,
+ BaseConnectionHelper::CONNECTION_TYPE_SERVER
+ );
}
/**
*
* @param $group Name of the pool group
* @param $poolSegment Name of the pool segment
- * @param $instance An instance of a class we should add to the pool
+ * @param $instance An instance of a class that should bed added to the pool
* @return void
*/
protected final function addInstance ($group, $poolName, Visitable $instance) {
/**
* Adds an entry to the pool
*
- * @param $poolEntry The new pool entry we should add
+ * @param $poolEntry The new pool entry that should be added
* @return void
*/
protected final function addPoolEntry ($poolEntry) {
// Is this entry visitable?
if ($poolEntry instanceof Visitable) {
// Visit this entry as well
+ //* NOISY-DEBUG: */ $this->debugOutput('BASE-POOL: Going to visit pooled object ' . $poolEntry->__toString() . ' with visitor ' . $visitorInstance->__toString() . ' ...');
$poolEntry->accept($visitorInstance);
} else {
// Cannot visit this entry
- $this->partialStub('Pool entry with key ' . $iteratorInstance->key() . ' has improper type ' . gettype($poolEntry) . '.');
+ $this->partialStub('Pool entry with key ' . $iteratorInstance->key() . ' has improper type ' . gettype($poolEntry) . ', reason: not implementing Visitable.');
}
// Advance to next entry
// Return it
return $array;
}
+
+ /**
+ * Checks whether the given connection type is valid
+ *
+ * @param $connectionType Type of connection, can be 'incoming', 'outgoing' or 'server'
+ * @return $isValid Whether the provided connection type is valid
+ */
+ protected function isValidConnectionType ($connectionType) {
+ // Is it valid?
+ $isValid = in_array($connectionType, $this->connectionTypes, true);
+
+ // Return result
+ return $isValid;
+ }
}
// [EOF]