Updated copyright year as this software has been changed in this year.

[hub.git] / application / hub / interfaces / helper / nodes / class_NodeHelper.php

diff --git a/application/hub/interfaces/helper/nodes/class_NodeHelper.php b/application/hub/interfaces/helper/nodes/class_NodeHelper.php
index ea990cacb7a4b698c06134b92953e16f6ef0cbfb..0d4f28765f8eb80ca270a8a6e93818fadc47478e 100644 (file)
--- a/application/hub/interfaces/helper/nodes/class_NodeHelper.php
+++ b/application/hub/interfaces/helper/nodes/class_NodeHelper.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  * @todo               We need to find a better name for this interface
@@ -109,18 +109,18 @@ interface NodeHelper extends Helper, AddableCriteria {
        function doSelfConnection (Taskable $taskInstance);
 
        /**
-        * "Getter for address:port combination
+        * Determines an instance of a LocateableNode class
         *
-        * @return      $addressPort    A address:port combination for this node
+        * @return      $unlInstance    An instance of a LocateableNode class for this node
         */
-       function getAddressPort ();
+       function determineUniversalNodeLocator ();
 
        /**
-        * "Getter for address:port array
+        * "Getter for an array of an instance of a LocateableNode class
         *
-        * @return      $addressPortArray       An array address:port combination for this node
+        * @return      $unlData        An array of an instance of a LocateableNode class
         */
-       function getAddressPortArray ();
+       function getUniversalNodeLocatorArray ();
 
        /**
         * Updates/refreshes node data (e.g. state).
@@ -141,7 +141,7 @@ interface NodeHelper extends Helper, AddableCriteria {
         *
         * @return      $hasAnnounced   Whether this node has attempted to announce itself
         */
-       function ifNodeHasAnnounced ();
+       function ifNodeIsAnnouncing ();
 
        /**
         * Checks whether this node has attempted to announce itself and completed it
@@ -172,6 +172,14 @@ interface NodeHelper extends Helper, AddableCriteria {
         * @return      $objectList             Array of all accepted object types
         */
        function getListFromAcceptedObjectTypes ();
+
+       /**
+        * Adds extra tasks to the given handler for this node
+        *
+        * @param       $handlerInstance        An instance of a HandleableTask class
+        * @return      void
+        */
+       function addExtraTasks (HandleableTask $handlerInstance);
 }
 
 // [EOF]