application/hub/interfaces/handler/chunks/class_HandleableChunks.php

   1 <?php
   2 /**
   3  * An interface for chunk handlers
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 HandleableChunks extends Handleable {
  25         /**
  26          * Adds all chunks if the last one verifies as a 'final chunk'.
  27          *
  28          * @param       $chunks         An array with chunks, the last one should be a 'final'
  29          * @return      void
  30          * @throws      FinalChunkVerificationException         If the final chunk does not start with 'EOP:'
  31          */
  32         function addAllChunksWithFinal (array $chunks);
  33
  34         /**
  35          * Adds all chunks and wait for more (e.g. incomplete transmission)
  36          *
  37          * @param       $chunks         An array with chunks, the last one should be a 'final'
  38          * @return      void
  39          */
  40         function addAllChunksWait (array $chunks);
  41
  42         /**
  43          * Checks whether unhandled chunks are available
  44          *
  45          * @return      $unhandledChunks        Whether unhandled chunks are left
  46          */
  47         function ifUnhandledChunksWithFinalAvailable ();
  48
  49         /**
  50          * Handles available chunks by processing one-by-one (not all together,
  51          * this would slow-down the whole application) with the help of an
  52          * iterator.
  53          *
  54          * @return      void
  55          */
  56         function handleAvailableChunksWithFinal ();
  57
  58         /**
  59          * Checks whether unassembled chunks are available (ready) in final array
  60          *
  61          * @return      $unassembledChunksAvailable             Whether unassembled chunks are available
  62          */
  63         function ifUnassembledChunksAvailable ();
  64
  65         /**
  66          * Assembles all chunks (except EOP and "hash chunk") back together to the original package data.
  67          *
  68          * This is done by the following steps:
  69          *
  70          * 1) Sort the final array with ksort(). This will bring the "hash
  71          *    chunk" up to the last array index and the EOP chunk to the
  72          *    pre-last array index
  73          * 2) Assemble all chunks except two last (see above step)
  74          * 3) While so, do the final check on all hashes
  75          * 4) If the package is assembled back together, hash it again for
  76          *    the very final verification.
  77          *
  78          * @return      void
  79          */
  80         function assembleChunksFromFinalArray ();
  81
  82         /**
  83          * Checks whether the raw package data has been assembled back together.
  84          * This can be safely assumed when rawPackageData is not empty and the
  85          * collection of all chunks is FALSE (because initHandler() will reset it).
  86          *
  87          * @return      $isRawPackageDataAvailable      Whether raw package data is available
  88          */
  89         function ifRawPackageDataIsAvailable ();
  90
  91         /**
  92          * Handles the finally assembled raw package data by feeding it into another
  93          * stacker for further decoding/processing.
  94          *
  95          * @return      void
  96          */
  97         function handledAssembledRawPackageData ();
  98 }
  99
 100 // [EOF]
 101 ?>