*/
interface HandleableProtocol extends Handleable {
/**
- * Getter for port number to satify HandleableProtocol
+ * Getter for protocol port number (if any)
*
- * @return $port The port number
+ * @return $port Port number used by the protocol (if any)
*/
- function getPort ();
+ function getProtocolPort ();
/**
* Getter for protocol name
* Checks whether given socket resource is registered. If $socketResource is
* FALSE only the instance will be checked.
*
- * @param $protocolInstance An instance of a HandleableProtocol class
+ * @param $listenerInstance An instance of a Listenable class
* @param $socketResource A valid socket resource
* @return $isRegistered Whether the given socket resource is registered
*/
- function isSocketRegistered (HandleableProtocol $protocolInstance, $socketResource);
+ function isSocketRegistered (Listenable $listenerInstance, $socketResource);
/**
* Registeres given socket for listener or throws an exception if it is already registered
*
- * @param $protocolInstance An instance of a HandleableProtocol class
+ * @param $listenerInstance An instance of a Listenable class
* @param $socketResource A valid socket resource
* @return void
* @throws SocketAlreadyRegisteredException If the given socket is already registered
*/
- function registerSocket (HandleableProtocol $protocolInstance, $socketResource);
+ function registerSocket (Listenable $listenerInstance, $socketResource);
/**
* Getter for given listener's socket resource
*
- * @param $protocolInstance An instance of a HandleableProtocol 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 (HandleableProtocol $protocolInstance);
+ function getRegisteredSocketResource (Listenable $listenerInstance);
/**
* "Getter" for protocol/connection instance from given package data
* Creates an instance of this Container class and prepares it for usage
*
* @param $socketResource A valid socket resource
- * @param $protocolInstance A HandleableProtocol instance
+ * @param $listenerInstance A Listenable instance
* @param $packageData Raw package data
* @return $containerInstance An instance of this Container class
*/
- public static final function createSocketContainer ($socketResource, HandleableProtocol $protocolInstance = NULL, array $packageData = array()) {
+ public static final function createSocketContainer ($socketResource, Listenable $listenerInstance = NULL, array $packageData = array()) {
// Get a new instance
$containerInstance = new SocketContainer();
$containerInstance->setSocketResource($socketResource);
// ..., protocol instance ...
- $containerInstance->setProtocolInstance($protocolInstance);
+ $containerInstance->setListenerInstance($listenerInstance);
// ... and package data
$containerInstance->setPackageData($packageData);