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

   1 <?php
   2 /**
   3  * Handleable chunks interface
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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          * Checks whether unhandled chunks are available
  36          *
  37          * @return      $unhandledChunks        Whether unhandled chunks are left
  38          */
  39         function ifUnhandledChunksWithFinalAvailable ();
  40
  41         /**
  42          * Handles available chunks by processing one-by-one (not all together,
  43          * this would slow-down the whole application) with the help of an
  44          * iterator.
  45          *
  46          * @return      void
  47          */
  48         function handleAvailableChunksWithFinal ();
  49 }
  50
  51 // [EOF]
  52 ?>