application/hub/interfaces/handler/network/class_Networkable.php

   1 <?php
   2 /**
   3  * A Networkable interface
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 Networkable extends HandleableDataSet {
  25         /**
  26          * Processes raw data from given resource. This is mostly useful for TCP
  27          * package handling and is implemented in the TcpListener class
  28          *
  29          * @param       $resourceArray  A valid socket resource array
  30          * @return      void
  31          * @throws      InvalidResourceException        If the given resource is invalid
  32          */
  33         function processRawDataFromResource (array $resourceArray);
  34
  35         /**
  36          * Checks whether decoded data is pending for further processing.
  37          *
  38          * @return      $isPending      Whether decoded data is pending
  39          */
  40         function isRawDataPending ();
  41
  42         /**
  43          * "Getter" for next decoded data from the stacker
  44          *
  45          * @return      $decodedData    Raw data from the stacker
  46          */
  47         function getNextRawData ();
  48 }
  49
  50 // [EOF]
  51 ?>