Added verfication of connection type in addPeer(), added more debug

[hub.git] / application / hub / main / pools / class_BasePool.php

diff --git a/application/hub/main/pools/class_BasePool.php b/application/hub/main/pools/class_BasePool.php
index 458dc656dac16e5d977308a95d64dfb866403ff3..708c4e5afca1fbf243877ba4a7f3c7fad67e68fc 100644 (file)
--- a/application/hub/main/pools/class_BasePool.php
+++ b/application/hub/main/pools/class_BasePool.php
@@ -4,7 +4,7 @@
  *
  * @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
  *
@@ -22,10 +22,21 @@
  * 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;
+       private $poolEntriesInstance = NULL;
+
+       /**
+        * An array with all valid connection types
+        */
+       private $connectionTypes = array();
 
        /**
         * Protected constructor
@@ -39,6 +50,13 @@ class BasePool extends BaseHubSystem implements Visitable {
 
                // 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
+               );
        }
 
        /**
@@ -55,7 +73,7 @@ class BasePool extends BaseHubSystem implements Visitable {
         *
         * @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) {
@@ -72,11 +90,11 @@ class BasePool extends BaseHubSystem implements Visitable {
        /**
         * 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) {
-               $this->getPoolEntriesInstance()->addEntry('generic', $poolEntry);
+               $this->getPoolEntriesInstance()->addEntry('pool', $poolEntry);
        }
 
        /**
@@ -92,8 +110,17 @@ class BasePool extends BaseHubSystem implements Visitable {
                // Visit this pool
                $visitorInstance->visitPool($this);
 
-               // Get a new iterator instance
-               $iteratorInstance = ObjectFactory::createObjectByConfiguredName($visitorInstance->getVisitorMode() . '_pool_iterator_class', array($this->getPoolEntriesInstance()));
+               // Do we have a registry instance for this visitor's iterator?
+               if (Registry::getRegistry()->instanceExists($visitorInstance->getVisitorMode() . '_pool_iterator')) {
+                       // Get the instance from registry
+                       $iteratorInstance = Registry::getRegistry()->getInstance($visitorInstance->getVisitorMode() . '_pool_iterator');
+               } else {
+                       // Get a new iterator instance
+                       $iteratorInstance = ObjectFactory::createObjectByConfiguredName($visitorInstance->getVisitorMode() . '_pool_iterator_class', array($this->getPoolEntriesInstance()));
+
+                       // Add it to the registry
+                       Registry::getRegistry()->addInstance($visitorInstance->getVisitorMode() . '_pool_iterator', $iteratorInstance);
+               }
 
                // Reset the counter
                $iteratorInstance->rewind();
@@ -106,10 +133,11 @@ class BasePool extends BaseHubSystem implements Visitable {
                        // 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
@@ -133,6 +161,20 @@ class BasePool extends BaseHubSystem implements Visitable {
                // 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]