Merge branch 'refacuring/protocol_handler' into latest-core/crawler

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

diff --git a/application/hub/interfaces/package/class_Deliverable.php b/application/hub/interfaces/package/class_Deliverable.php
index 48ea7beb77662c2df66dbc7aad3517292044cab7..5833e0537ef196c98b7e172f9624630f600e85bd 100644 (file)
--- a/application/hub/interfaces/package/class_Deliverable.php
+++ b/application/hub/interfaces/package/class_Deliverable.php
@@ -2,11 +2,11 @@
 /**
  * An interface for package delivery boys... ;-)
  *
- * @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 - 2015 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
@@ -24,35 +24,42 @@
 interface Deliverable extends FrameworkInterface {
        /**
         * "Enqueues" raw content into this delivery class by reading the raw content
-        * from given template instance and pushing it on the 'undeclared' stack.
+        * from given helper's template instance and pushing it on the 'undeclared'
+        * stack.
         *
-        * @param       $helperInstance         An instance of a BaseHubHelper class
-        * @param       $nodeInstance           An instance of a NodeHelper class
+        * @param       $helperInstance         An instance of a HubHelper class
         * @return      void
         */
-       function enqueueRawDataFromTemplate (BaseHubHelper $helperInstance, NodeHelper $nodeInstance);
+       function enqueueRawDataFromTemplate (HubHelper $helperInstance);
 
        /**
-        * Checks wether a package has been enqueued for delivery.
+        * Checks whether a package has been enqueued for delivery.
         *
-        * @return      $isEnqueued             Wether a package is enqueued
+        * @return      $isEnqueued             Whether a package is enqueued
         */
        function isPackageEnqueued ();
 
        /**
-        * Checks wether a package has been declared
+        * Checks whether a package has been declared
         *
-        * @return      $isDeclared             Wether a package is declared
+        * @return      $isDeclared             Whether a package is declared
         */
        function isPackageDeclared ();
 
        /**
-        * Checks wether a package should be sent out
+        * Checks whether a package should be sent out
         *
-        * @return      $isWaitingDelivery      Wether a package is waiting for delivery
+        * @return      $isWaitingDelivery      Whether a package is waiting for delivery
         */
        function isPackageWaitingForDelivery ();
 
+       /**
+        * Checks whether encoded (raw) data is pending
+        *
+        * @return      $isPending      Whether encoded data is pending
+        */
+       function isEncodedDataPending ();
+
        /**
         * Delivers an enqueued package to the stated destination. If a non-session
         * id is provided, recipient resolver is being asked (and instanced once).
@@ -66,13 +73,13 @@ interface Deliverable extends FrameworkInterface {
        function declareEnqueuedPackage ();
 
        /**
-        * Delivers the next declared package. Only one package per time will be sent
-        * because this may take time and slows down the whole delivery
+        * Processes the next declared package. Only one package per time will be
+        * processed because this may take time and slows down the whole delivery
         * infrastructure.
         *
         * @return      void
         */
-       function deliverDeclaredPackage ();
+       function processDeclaredPackage ();
 
        /**
         * Sends waiting packages out for delivery
@@ -80,6 +87,20 @@ interface Deliverable extends FrameworkInterface {
         * @return      void
         */
        function sendWaitingPackage ();
+
+       /**
+        * Sends pending encoded (raw) data
+        *
+        * @return      void
+        */
+       function sendEncodedData ();
+
+       /**
+        * Clears all stacks
+        *
+        * @return      void
+        */
+       function clearAllStacks ();
 }
 
 // [EOF]