Sometimes it is Listenable, somtimes HandleableProtocol ... ;-)
authorRoland Haeder <roland@mxchange.org>
Sat, 10 Jan 2015 22:21:32 +0000 (23:21 +0100)
committerRoland Haeder <roland@mxchange.org>
Sat, 10 Jan 2015 22:21:32 +0000 (23:21 +0100)
Signed-off-by: Roland Häder <roland@mxchange.org>
inc/classes/interfaces/handler/protocol/class_HandleableProtocol.php
inc/classes/interfaces/registry/socket/class_RegisterableSocket.php
inc/classes/main/container/socket/class_SocketContainer.php

index 0a65360e16bbec5db3590216fae3c8d43e583f88..8cfe6d60c8fd634efe0005ad7f8fe145c56cc208 100644 (file)
  */
 interface HandleableProtocol extends Handleable {
        /**
-        * Getter for protocol port number (if any)
+        * Getter for port number to satify HandleableProtocol
         *
-        * @return      $port   Port number used by the protocol (if any)
+        * @return      $port   The port number
         */
-       function getProtocolPort ();
+       function getPort ();
 
        /**
         * Getter for protocol name
index 438bc21d0b1fd79ed40443985504d5b0109e7fde..6a93f752fb0d7c437d006055709650263951124a 100644 (file)
@@ -26,30 +26,30 @@ interface RegisterableSocket extends Registerable {
         * 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       $protocolInstance       An instance of a HandleableProtocol class
         * @param       $socketResource         A valid socket resource
         * @return      $isRegistered           Whether the given socket resource is registered
         */
-       function isSocketRegistered (Listenable $listenerInstance, $socketResource);
+       function isSocketRegistered (HandleableProtocol $protocolInstance, $socketResource);
 
        /**
         * Registeres given socket for listener or throws an exception if it is already registered
         *
-        * @param       $listenerInstance       An instance of a Listenable class
+        * @param       $protocolInstance       An instance of a HandleableProtocol 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 (HandleableProtocol $protocolInstance, $socketResource);
 
        /**
         * Getter for given listener's socket resource
         *
-        * @param       $listenerInstance       An instance of a Listenable class
+        * @param       $protocolInstance       An instance of a HandleableProtocol class
         * @return      $socketResource         A valid socket resource
         * @throws      NoSocketRegisteredException             If the requested socket is not registered
         */
-       function getRegisteredSocketResource (Listenable $listenerInstance);
+       function getRegisteredSocketResource (HandleableProtocol $protocolInstance);
 
        /**
         * "Getter" for protocol/connection instance from given package data
index c78a56f232dc8c6dfa1681dcc1da30e4083078e4..bfc3bd2cc3967dfd4c83747db23d7955dadd1f64 100644 (file)
@@ -36,11 +36,11 @@ class SocketContainer extends BaseContainer implements Registerable {
         * Creates an instance of this Container class and prepares it for usage
         *
         * @param       $socketResource         A valid socket resource
-        * @param       $listenerInstance       A Listenable instance
+        * @param       $protocolInstance       A HandleableProtocol instance
         * @param       $packageData            Raw package data
         * @return      $containerInstance      An instance of this Container class
         */
-       public static final function createSocketContainer ($socketResource, Listenable $listenerInstance = NULL, array $packageData = array()) {
+       public static final function createSocketContainer ($socketResource, HandleableProtocol $protocolInstance = NULL, array $packageData = array()) {
                // Get a new instance
                $containerInstance = new SocketContainer();
 
@@ -55,7 +55,7 @@ class SocketContainer extends BaseContainer implements Registerable {
                $containerInstance->setSocketResource($socketResource);
 
                // ..., protocol instance ...
-               $containerInstance->setListenerInstance($listenerInstance);
+               $containerInstance->setProtocolInstance($protocolInstance);
 
                // ... and package data
                $containerInstance->setPackageData($packageData);