application/hub/interfaces/package/assembler/class_Assembler.php

   1 <?php
   2 /**
   3  * An interface for a package assembler
   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 Assembler extends FrameworkInterface {
  25         /**
  26          * Chunks the content from $packageContent and feeds it into another queue
  27          * for verification and possible re-requesting.
  28          *
  29          * @param       $packageContent         An array with two elements: 'decoded_data' and 'error_code'
  30          * @return      void
  31          */
  32         function chunkPackageContent (array $packageContent);
  33
  34         /**
  35          * Checks whether the assembler's pending data is empty which means it has
  36          * no pending data left for handling ... ;-)
  37          *
  38          * @return      $ifPendingDataIsEmpty   Whether pending data is empty
  39          */
  40         function isPendingDataEmpty ();
  41
  42         /**
  43          * Handles the assembler's pending data
  44          *
  45          * @return      void
  46          */
  47         function handlePendingData ();
  48 }
  49
  50 // [EOF]
  51 ?>