application/hub/interfaces/package/class_Receivable.php

   1 <?php
   2 /**
   3  * An interface for package receivers
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 Receivable extends FrameworkInterface {
  25         /**
  26          * Checks whether new raw data from the socket has arrived
  27          *
  28          * @param       $poolInstance   An instance of a PoolableListener class
  29          * @return      $hasArrived             Whether raw package data has arrived at a socket
  30          */
  31         function isNewRawDataPending (PoolableListener $poolInstance);
  32
  33         /**
  34          * Handles the incoming decoded raw data. This method does not "convert" the
  35          * decoded data back into a package array, it just "handles" it and pushs it
  36          * on the next stack.
  37          *
  38          * @return      void
  39          */
  40         function handleIncomingDecodedData ();
  41
  42         /**
  43          * Checks whether incoming decoded data is handled.
  44          *
  45          * @return      $isHandled      Whether incoming decoded data is handled
  46          */
  47         function isIncomingRawDataHandled ();
  48
  49         /**
  50          * Assembles incoming decoded data so it will become an abstract network
  51          * package again.
  52          *
  53          * @return      void
  54          */
  55         function assembleDecodedDataToPackage ();
  56
  57         /**
  58          * Checks whether a new message has arrived
  59          *
  60          * @return      $hasArrived             Whether a new message has arrived for processing
  61          */
  62         function isNewMessageArrived ();
  63
  64         /**
  65          * Handle newly arrived message
  66          *
  67          * @return      void
  68          */
  69         function handleNewlyArrivedMessage ();
  70
  71         /**
  72          * Checks whether a processed message is pending for "interpretation"
  73          *
  74          * @return      $isPending      Whether a processed message is pending
  75          */
  76         function isProcessedMessagePending ();
  77
  78         /**
  79          * Handle processed messages by "interpreting" the 'message_type' element
  80          *
  81          * @return      void
  82          */
  83         function handleProcessedMessage ();
  84
  85         /**
  86          * Adds raw decoded data from the given handler instance to this receiver
  87          *
  88          * @param       $handlerInstance        An instance of a Networkable class
  89          * @return      void
  90          */
  91         function addRawDataToIncomingStack (Networkable $handlerInstance);
  92
  93         /**
  94          * "Decode" the package content. This method does also verify the attached hash
  95          * against the real raw package data (that what the sender has sent).
  96          *
  97          * @param       $rawPackageContent      The raw package content to be "decoded"
  98          * @return      $decodedData            The real package data that the sender has sent
  99          */
 100         function decodeRawContent ($rawPackageContent);
 101
 102         /**
 103          * Checks whether the assembler has pending data left
 104          *
 105          * @return      $isHandled      Whether the assembler has pending data left
 106          */
 107         function ifAssemblerHasPendingDataLeft ();
 108
 109         /**
 110          * Handles the attached assemler's pending data queue to be finally
 111          * assembled to the raw package data back.
 112          *
 113          * @return      void
 114          */
 115         function handleAssemblerPendingData ();
 116
 117         /**
 118          * Handles decoded data for this node
 119          *
 120          * @param       $decodedData    An array with decoded raw package data
 121          * @return      void
 122          */
 123         function handleRawData (array $decodedData);
 124
 125         /**
 126          * Checks whether the assembler has multiple messages pending
 127          *
 128          * @return      $isPending      Whether the assembler has multiple messages pending
 129          */
 130         function ifMultipleMessagesPending ();
 131
 132         /**
 133          * Handles multiple messages.
 134          *
 135          * @return      void
 136          */
 137         function handleMultipleMessages ();
 138 }
 139
 140 // [EOF]
 141 ?>