application/hub/interfaces/pool/peer/class_PoolablePeer.php

   1 <?php
   2 /**
   3  * A default peer pool class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 PoolablePeer extends Poolable, SocketTag {
  25         /**
  26          * Adds a socket resource to the peer pool
  27          *
  28          * @param       $socketResource         A valid (must be!) socket resource
  29          * @param       $connectionType         Type of connection, can only be 'incoming', 'outgoing' or 'server'
  30          * @return      void
  31          * @throws      InvalidSocketException  If the given resource is invalid or errorous
  32          * @throws      InvalidConnectionTypeException  If the provided connection type is not valid
  33          */
  34         function addPeer ($socketResource, $connectionType);
  35
  36         /**
  37          * Getter for array of all socket resource arrays
  38          *
  39          * @return      $sockets        An array with all socket arrays
  40          */
  41         function getAllSockets ();
  42
  43         /**
  44          * Getter for array of all socket resources
  45          *
  46          * @return      $sockets        An array with all sockets
  47          */
  48         function getAllSingleSockets ();
  49
  50         /**
  51          * "Getter" for all sockets of specified type
  52          *
  53          * @param       $connectionType         Type of connection, can only be 'incoming', 'outgoing' or 'server'
  54          * @return      $sockets                        An array with sockets of given type
  55          * @throws      InvalidConnectionTypeException  If the provided connection type is not valid
  56          */
  57         function getSocketsByConnectionType ($connectionType);
  58 }
  59
  60 // [EOF]
  61 ?>