Minor things improved + TODO added as it is unfinished.

[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 470b90d3bdaab29c2f637138539d26feee760ab9..7f6b56c2ccef60dd2488e52316143557801390c1 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 - 2012 Hub Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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
@@ -27,11 +27,10 @@ interface Deliverable extends FrameworkInterface {
         * from given helper's template instance and pushing it on the 'undeclared'
         * stack.
         *
-        * @param       $helperInstance         An instance of a Helper class
-        * @param       $protocol                       Name of used protocol (TCP/UDP)
+        * @param       $helperInstance         An instance of a HubHelper class
         * @return      void
         */
-       function enqueueRawDataFromTemplate (Helper $helperInstance, $protocol);
+       function enqueueRawDataFromTemplate (HubHelper $helperInstance);
 
        /**
         * Checks whether a package has been enqueued for delivery.
@@ -54,6 +53,13 @@ interface Deliverable extends FrameworkInterface {
         */
        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).
@@ -67,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
@@ -82,6 +88,13 @@ interface Deliverable extends FrameworkInterface {
         */
        function sendWaitingPackage ();
 
+       /**
+        * Sends pending encoded (raw) data
+        *
+        * @return      void
+        */
+       function sendEncodedData ();
+
        /**
         * Clears all stacks
         *