Updated domain without a dash :(

[hub.git] / application / hub / interfaces / package / class_Receivable.php

diff --git a/application/hub/interfaces/package/class_Receivable.php b/application/hub/interfaces/package/class_Receivable.php
index fe1be45b895eadb05c8e6c8c5454669fcdc6b74c..33bd24c1fe3c85e19b838005700feb28e114a65e 100644 (file)
--- a/application/hub/interfaces/package/class_Receivable.php
+++ b/application/hub/interfaces/package/class_Receivable.php
@@ -2,11 +2,11 @@
 /**
  * An interface for package receivers
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.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
+ * @link               http://www.shipsimu.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
@@ -44,7 +44,7 @@ interface Receivable extends FrameworkInterface {
         *
         * @return      $isHandled      Whether incoming decoded data is handled
         */
-       function isIncomingDecodedDataHandled ();
+       function isIncomingRawDataHandled ();
 
        /**
         * Assembles incoming decoded data so it will become an abstract network
@@ -55,11 +55,32 @@ interface Receivable extends FrameworkInterface {
        function assembleDecodedDataToPackage ();
 
        /**
-        * Checks whether a new package has arrived
+        * Checks whether a new message has arrived
         *
-        * @return      $hasArrived             Whether a new package has arrived for processing
+        * @return      $hasArrived             Whether a new message has arrived for processing
         */
-       function isNewPackageArrived ();
+       function isNewMessageArrived ();
+
+       /**
+        * Handle newly arrived message
+        *
+        * @return      void
+        */
+       function handleNewlyArrivedMessage ();
+
+       /**
+        * Checks whether a processed message is pending for "interpretation"
+        *
+        * @return      $isPending      Whether a processed message is pending
+        */
+       function isProcessedMessagePending ();
+
+       /**
+        * Handle processed messages by "interpreting" the 'message_type' element
+        *
+        * @return      void
+        */
+       function handleProcessedMessage ();
 
        /**
         * Adds raw decoded data from the given handler instance to this receiver
@@ -67,7 +88,7 @@ interface Receivable extends FrameworkInterface {
         * @param       $handlerInstance        An instance of a Networkable class
         * @return      void
         */
-       function addDecodedDataToIncomingStack (Networkable $handlerInstance);
+       function addRawDataToIncomingStack (Networkable $handlerInstance);
 
        /**
         * "Decode" the package content. This method does also verify the attached hash
@@ -92,6 +113,14 @@ interface Receivable extends FrameworkInterface {
         * @return      void
         */
        function handleAssemblerPendingData ();
+
+       /**
+        * Handles decoded data for this node
+        *
+        * @param       $decodedData    An array with decoded raw package data
+        * @return      void
+        */
+       function handleRawData (array $decodedData);
 }
 
 // [EOF]