framework/main/interfaces/registry/socket/class_RegisterableSocket.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Registry\Socket;
   4
   5 // Import framework stuff
   6 use CoreFramework\Listener\Listenable;
   7 use CoreFramework\Registry\Registerable;
   8
   9 /**
  10  * A class for registerable socket classes
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 interface RegisterableSocket extends Registerable {
  32         /**
  33          * Checks whether given socket resource is registered. If $socketResource is
  34          * false only the instance will be checked.
  35          *
  36          * @param       $infoInstance           An instance of a ShareableInfo class
  37          * @param       $socketResource         A valid socket resource
  38          * @return      $isRegistered           Whether the given socket resource is registered
  39          */
  40         function isSocketRegistered (ShareableInfo $infoInstance, $socketResource);
  41
  42         /**
  43          * Registeres given socket for listener or throws an exception if it is already registered
  44          *
  45          * @param       $infoInstance   An instance of a ShareableInfo class
  46          * @param       $socketResource         A valid socket resource
  47          * @return      void
  48          * @throws      SocketAlreadyRegisteredException        If the given socket is already registered
  49          */
  50         function registerSocket (ShareableInfo $infoInstance, $socketResource);
  51
  52         /**
  53          * Getter for given listener's socket resource
  54          *
  55          * @param       $listenerInstance       An instance of a Listenable class
  56          * @return      $socketResource         A valid socket resource
  57          * @throws      NoSocketRegisteredException             If the requested socket is not registered
  58          */
  59         function getRegisteredSocketResource (Listenable $listenerInstance);
  60
  61         /**
  62          * "Getter" for info instance from given package data
  63          *
  64          * @param       $packageData    Raw package data
  65          * @return      $infoInstance   An instance of a ShareableInfo class
  66          */
  67         function getInfoInstanceFromPackageData (array $packageData);
  68
  69 }