application/hub/interfaces/helper/connections/class_ConnectionHelper.php

   1 <?php
   2 /**
   3  * An interface for connection helper classes
   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 ConnectionHelper extends Helper {
  25         /**
  26          * Sends raw package data to the recipient
  27          *
  28          * @param       $packageData            Raw package data
  29          * @return      $totalSentBytes         Total sent bytes to the peer
  30          * @throws      InvalidSocketException  If we got a problem with this socket
  31          */
  32         function sendRawPackageData (array $packageData);
  33
  34         /**
  35          * Checks wether the connect retry is exhausted
  36          *
  37          * @return      $isExhaused             Wether connect retry is exchausted
  38          */
  39         function isConnectRetryExhausted ();
  40
  41         /**
  42          * Do the shutdown sequence for this connection helper
  43          *
  44          * @todo        We may want to implement a filter for ease notification of other objects like our pool
  45          * @return      void
  46          * @throws      SocketShutdownException         If the current socket could not be shut down
  47          */
  48         function doShutdown ();
  49 }
  50
  51 // [EOF]
  52 ?>