Added handler for announcement messages (not yet functional)

[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 869a710bfd2640231e06e400bdc2668c40235dc2..0a6dcb384b65bf9f7255c2b64311bccbf8006021 100644 (file)
--- a/application/hub/interfaces/package/class_Receivable.php
+++ b/application/hub/interfaces/package/class_Receivable.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
  *
@@ -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
@@ -77,6 +98,29 @@ interface Receivable extends FrameworkInterface {
         * @return      $decodedData            The real package data that the sender has sent
         */
        function decodeRawContent ($rawPackageContent);
+
+       /**
+        * Checks whether the assembler has pending data left
+        *
+        * @return      $isHandled      Whether the assembler has pending data left
+        */
+       function ifAssemblerHasPendingDataLeft ();
+
+       /**
+        * Handles the attached assemler's pending data queue to be finally
+        * assembled to the raw package data back.
+        *
+        * @return      void
+        */
+       function handleAssemblerPendingData ();
+
+       /**
+        * Handles decoded data for this node
+        *
+        * @param       $decodedData    An array with decoded raw package data
+        * @return      void
+        */
+       function handleDecodedData (array $decodedData);
 }
 
 // [EOF]