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