application/hub/interfaces/package/class_Deliverable.php

   1 <?php
   2 /**
   3  * An interface for package delivery boys... ;-)
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface Deliverable extends FrameworkInterface {
  25         /**
  26          * "Enqueues" raw content into this delivery class by reading the raw content
  27          * from given helper's template instance and pushing it on the 'undeclared'
  28          * stack.
  29          *
  30          * @param       $helperInstance         An instance of a Helper class
  31          * @param       $protocol                       Name of used protocol (TCP/UDP)
  32          * @return      void
  33          */
  34         function enqueueRawDataFromTemplate (Helper $helperInstance, $protocol);
  35
  36         /**
  37          * Checks whether a package has been enqueued for delivery.
  38          *
  39          * @return      $isEnqueued             Whether a package is enqueued
  40          */
  41         function isPackageEnqueued ();
  42
  43         /**
  44          * Checks whether a package has been declared
  45          *
  46          * @return      $isDeclared             Whether a package is declared
  47          */
  48         function isPackageDeclared ();
  49
  50         /**
  51          * Checks whether a package should be sent out
  52          *
  53          * @return      $isWaitingDelivery      Whether a package is waiting for delivery
  54          */
  55         function isPackageWaitingForDelivery ();
  56
  57         /**
  58          * Checks whether encoded (raw) data is pending
  59          *
  60          * @return      $isPending              Whether encoded data is pending
  61          */
  62         function isEncodedDataPending ();
  63
  64         /**
  65          * Delivers an enqueued package to the stated destination. If a non-session
  66          * id is provided, recipient resolver is being asked (and instanced once).
  67          * This allows that a single package is being delivered to multiple targets
  68          * without enqueueing it for every target. If no target is provided or it
  69          * can't be determined a NoTargetException is being thrown.
  70          *
  71          * @return      void
  72          * @throws      NoTargetException       If no target can't be determined
  73          */
  74         function declareEnqueuedPackage ();
  75
  76         /**
  77          * Processes the next declared package. Only one package per time will be
  78          * processed because this may take time and slows down the whole delivery
  79          * infrastructure.
  80          *
  81          * @return      void
  82          */
  83         function processDeclaredPackage ();
  84
  85         /**
  86          * Sends waiting packages out for delivery
  87          *
  88          * @return      void
  89          */
  90         function sendWaitingPackage ();
  91
  92         /**
  93          * Sends pending encoded (raw) data
  94          *
  95          * @return      void
  96          */
  97         function sendEncodedData ();
  98
  99         /**
 100          * Clears all stacks
 101          *
 102          * @return      void
 103          */
 104         function clearAllStacks ();
 105 }
 106
 107 // [EOF]
 108 ?>