]> git.mxchange.org Git - core.git/blobdiff - inc/classes/interfaces/registry/socket/class_RegisterableSocket.php
Now use more the newly added (not here yet) ShareabeInfo instance.
[core.git] / inc / classes / interfaces / registry / socket / class_RegisterableSocket.php
index 9a3ef45cd6a280f883810590a56029d529c3beae..cd7c41cd44e5f4788de6c3f4ef8c4d1681151c25 100644 (file)
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.shipsimu.org
  *
@@ -26,38 +26,38 @@ interface RegisterableSocket extends Registerable {
         * Checks whether given socket resource is registered. If $socketResource is
         * FALSE only the instance will be checked.
         *
-        * @param       $protocolInstance       An instance of a ProtocolHandler class
+        * @param       $infoInstance           An instance of a ShareableInfo class
         * @param       $socketResource         A valid socket resource
         * @return      $isRegistered           Whether the given socket resource is registered
         */
-       function isSocketRegistered (ProtocolHandler $protocolInstance, $socketResource);
+       function isSocketRegistered (ShareableInfo $infoInstance, $socketResource);
 
        /**
         * Registeres given socket for listener or throws an exception if it is already registered
         *
-        * @param       $protocolInstance       An instance of a ProtocolHandler 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 (ProtocolHandler $protocolInstance, $socketResource);
+       function registerSocket (ShareableInfo $infoInstance, $socketResource);
 
        /**
         * Getter for given listener's socket resource
         *
-        * @param       $protocolInstance       An instance of a ProtocolHandler class
+        * @param       $listenerInstance       An instance of a Listenable class
         * @return      $socketResource         A valid socket resource
         * @throws      NoSocketRegisteredException             If the requested socket is not registered
         */
-       function getRegisteredSocketResource (ProtocolHandler $protocolInstance);
+       function getRegisteredSocketResource (Listenable $listenerInstance);
 
        /**
-        * "Getter" for protocol/connection instance from given package data
+        * "Getter" for info instance from given package data
         *
-        * @param       $packageData            Raw package data
-        * @return      $protocolInstance       An instance of a ProtocolHandler class
+        * @param       $packageData    Raw package data
+        * @return      $infoInstance   An instance of a ShareableInfo class
         */
-       function getHandlerInstanceFromPackageData (array $packageData);
+       function getInfoInstanceFromPackageData (array $packageData);
 }
 
 // [EOF]