application/hub/interfaces/package/fragmenter/class_Fragmentable.php

   1 <?php
   2 /**
   3  * An interface for a package fragmenter
   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 Fragmentable extends FrameworkInterface {
  25         /**
  26          * This method does "implode" the given package data array into one long
  27          * string, splits it into small chunks, adds a serial number and checksum
  28          * to all chunks and prepends a final hashsum chunk. It will return the
  29          * final hash for faster processing of packages.
  30          *
  31          * @param       $packageData            Raw package data array
  32          * @param       $helperInstance         An instance of a ConnectionHelper class
  33          * @return      $finalHash                      Final hash for faster processing
  34          */
  35         function fragmentPackageArray (array $packageData, ConnectionHelper $helperInstance);
  36
  37         /**
  38          * This method gets the next chunk from the internal FIFO which should be
  39          * sent to the given recipient. It will return an associative array where
  40          * the key is the chunk hash and value the raw chunk data.
  41          *
  42          * @param       $finalHash              Final hash for faster lookup
  43          * @return      $rawDataChunk   Raw package data chunk
  44          */
  45         function getNextRawDataChunk ($finalHash);
  46 }
  47
  48 // [EOF]
  49 ?>