Opps, forgot this.

[core.git] / inc / classes / interfaces / registry / socket / class_RegisterableSocket.php

diff --git a/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php b/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php
index a97574830ab2d58903d8019c28256eb129738e06..efe266a80d0d5a7da330acd3d96fb830131ec360 100644 (file)
--- a/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php
+++ b/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php
@@ -2,11 +2,11 @@
 /**
  * A class for registerable socket classes
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,24 +23,24 @@
  */
 interface RegisterableSocket extends Registerable {
        /**
-        * Checks wether given socket resource is registered. If $socketResource is
-        * false only the instance will be checked.
+        * Checks whether given socket resource is registered. If $socketResource is
+        * FALSE only the instance will be checked.
         *
-        * @param       $listenerInstance       An instance of a Listenable class
+        * @param       $infoInstance           An instance of a ShareableInfo class
         * @param       $socketResource         A valid socket resource
-        * @return      $isRegistered           Wether the given socket resource is registered
+        * @return      $isRegistered           Whether the given socket resource is registered
         */
-       function isSocketRegistered (Listenable $listenerInstance, $socketResource);
+       function isSocketRegistered (ShareableInfo $infoInstance, $socketResource);
 
        /**
         * Registeres given socket for listener or throws an exception if it is already registered
         *
-        * @param       $listenerInstance       An instance of a Listenable class
+        * @param       $infoInstance   An instance of a ShareableInfo class
         * @param       $socketResource         A valid socket resource
         * @return      void
         * @throws      SocketAlreadyRegisteredException        If the given socket is already registered
         */
-       function registerSocket (Listenable $listenerInstance, $socketResource);
+       function registerSocket (ShareableInfo $infoInstance, $socketResource);
 
        /**
         * Getter for given listener's socket resource
@@ -49,7 +49,15 @@ interface RegisterableSocket extends Registerable {
         * @return      $socketResource         A valid socket resource
         * @throws      NoSocketRegisteredException             If the requested socket is not registered
         */
-       function getSocketResource (Listenable $listenerInstance);
+       function getRegisteredSocketResource (Listenable $listenerInstance);
+
+       /**
+        * "Getter" for info instance from given package data
+        *
+        * @param       $packageData    Raw package data
+        * @return      $infoInstance   An instance of a ShareableInfo class
+        */
+       function getInfoInstanceFromPackageData (array $packageData);
 }
 
 // [EOF]