Refactured sending encoded (raw) data to sockets to a stacker-based approach.

[hub.git] / application / hub / main / nodes / class_BaseHubNode.php

diff --git a/application/hub/main/nodes/class_BaseHubNode.php b/application/hub/main/nodes/class_BaseHubNode.php
index 3ae7f8bc8f0f7c4cee05f2221a912b242aa5d976..b32c3dc905b5b043415aafbb6f7cc20068acdbbe 100644 (file)
--- a/application/hub/main/nodes/class_BaseHubNode.php
+++ b/application/hub/main/nodes/class_BaseHubNode.php
@@ -67,6 +67,11 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
         */
        private $acceptAnnouncements = FALSE;
 
+       /**
+        * Whether this node accepts DHT bootstrap requests (default: FALSE)
+        */
+       private $acceptDhtBootstrap = FALSE;
+
        /**
         * Protected constructor
         *
@@ -223,7 +228,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
                                $this->bootIpPort = $ipPort;
 
                                // Output message
-                               self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.');
+                               self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __METHOD__ . ':' . __LINE__ . ']: IP matches remote address ' . $ipPort . '.');
 
                                // Stop further searching
                                break;
@@ -238,7 +243,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
                                $this->bootIpPort = $ipPort;
 
                                // Output message
-                               self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.');
+                               self::createDebugInstance(__CLASS__)->debugOutput('BOOTSTRAP: ' . __FUNCTION__ . '[' . __METHOD__ . ':' . __LINE__ . ']: IP matches listen address ' . $ipPort . '.');
 
                                // Stop further searching
                                break;
@@ -474,7 +479,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
                $helperInstance->sendPackage($this);
 
                // Change the state, this should be the last line except debug output
-               $this->getStateInstance()->nodeAnnouncedToUpperHubs();
+               $this->getStateInstance()->nodeAnnouncingToUpperHubs();
 
                // Debug output
                self::createDebugInstance(__CLASS__)->debugOutput('HUB-Announcement: FINISHED');
@@ -490,7 +495,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
         */
        public function doSelfConnection (Taskable $taskInstance) {
                // Debug output
-               self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: Self Connection: START (taskInstance=' . $taskInstance->__toString(). ')');
+               self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Self Connection: START (taskInstance=' . $taskInstance->__toString(). ')');
 
                // Get a helper instance
                $helperInstance = ObjectFactory::createObjectByConfiguredName('node_self_connect_helper_class', array($this));
@@ -505,7 +510,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
                $helperInstance->sendPackage($this);
 
                // Debug output
-               self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: Self Connection: FINISHED');
+               self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Self Connection: FINISHED');
        }
 
        /**
@@ -543,7 +548,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
         */
        public function initializeListenerPool () {
                // Debug output
-               self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: Initialize listener: START');
+               self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Initialize listener: START');
 
                // Get a new pool instance
                $this->setListenerPoolInstance(ObjectFactory::createObjectByConfiguredName('listener_pool_class', array($this)));
@@ -603,7 +608,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
                $this->getListenerPoolInstance()->addListener($decoratorInstance);
 
                // Debug output
-               self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: Initialize listener: FINISHED.');
+               self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Initialize listener: FINISHED.');
        }
 
        /**
@@ -638,6 +643,19 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
                return $acceptAnnouncements;
        }
 
+       /**
+        * Checks whether this node accepts DHT bootstrap requests
+        *
+        * @return      $acceptDhtBootstrap     Whether this node accepts DHT bootstrap requests
+        */
+       public final function isAcceptingDhtBootstrap () {
+               // Check it (this node must be active and not shutdown!)
+               $acceptDhtBootstrap = (($this->acceptDhtBootstrap === TRUE) && ($this->isNodeActive()));
+
+               // Return it
+               return $acceptDhtBootstrap;
+       }
+
        /**
         * Checks whether this node has attempted to announce itself
         *
@@ -646,13 +664,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
         */
        public function ifNodeHasAnnounced () {
                // Debug message
-               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: ifNodeHasAnnounced(): state=' . $this->getStateInstance()->getStateName());
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeHasAnnounced(): state=' . $this->getStateInstance()->getStateName());
 
                // Simply check the state of this node
                $hasAnnounced = ($this->getStateInstance() instanceof NodeAnnouncedState);
 
                // Debug message
-               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: ifNodeHasAnnounced(): hasAnnounced=' . intval($hasAnnounced));
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeHasAnnounced(): hasAnnounced=' . intval($hasAnnounced));
 
                // Return it
                return $hasAnnounced;
@@ -666,13 +684,13 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
         */
        public function ifNodeHasAnnouncementCompleted () {
                // Debug message
-               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): state=' . $this->getStateInstance()->getStateName());
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): state=' . $this->getStateInstance()->getStateName());
 
                // Simply check the state of this node
                $hasAnnouncementCompleted = ($this->getStateInstance() instanceof NodeAnnouncementCompletedState);
 
                // Debug message
-               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted));
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: ifNodeHasAnnouncementCompleted(): hasAnnouncementCompleted=' . intval($hasAnnouncementCompleted));
 
                // Return it
                return $hasAnnouncementCompleted;
@@ -688,6 +706,17 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
                $this->acceptAnnouncements = $acceptAnnouncements;
        }
 
+       /**
+        * Enables whether this node accepts DHT bootstrap requests
+        *
+        * @param       $acceptDhtBootstrap     Whether this node accepts DHT bootstrap requests (default: TRUE)
+        * @return      void
+        */
+       public final function enableAcceptDhtBootstrap ($acceptDhtBootstrap = TRUE) {
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: Enabling DHT bootstrap requests ...');
+               $this->acceptDhtBootstrap = $acceptDhtBootstrap;
+       }
+
        /**
         * Checks wether this node is accepting node-list requests
         *
@@ -796,7 +825,7 @@ class BaseHubNode extends BaseHubSystem implements Updateable, AddableCriteria {
                                $dataSetInstance->addCriteria($element, $nodeData[$element]);
                        } else {
                                // Output warning message
-                               /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __LINE__ . ']: addArrayToDataSet(): Element ' . $element . ' not found in nodeData array.');
+                               /* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('NODE[' . __METHOD__ . ':' . __LINE__ . ']: addArrayToDataSet(): Element ' . $element . ' not found in nodeData array.');
                        }
                } // END - foreac
        }