application/hub/interfaces/decoder/class_Decodeable.php

   1 <?php
   2 /**
   3  * An interface for decoders
   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 Decodeable extends FrameworkInterface {
  25         /**
  26          * Checks whether the assoziated stacker for raw package data has some entries left
  27          *
  28          * @return      $unhandledDataLeft      Whether some unhandled raw package data is left
  29          */
  30         function ifUnhandledRawPackageDataLeft ();
  31
  32         /**
  33          * Handles raw package data by decoding it
  34          *
  35          * @return      void
  36          */
  37         function handleRawPackageData ();
  38
  39         /**
  40          * Checks whether decoded packages have arrived (for this peer)
  41          *
  42          * @return      $ifDecodedPackagesLeft  Whether decoded packages have arrived
  43          */
  44         function ifDeocedPackagesLeft ();
  45
  46         /**
  47          * Handles received decoded packages internally (recipient is this node)
  48          *
  49          * @return      void
  50          */
  51         function handleDecodedPackage ();
  52 }
  53
  54 // [EOF]
  55 ?>