X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=inc%2Fclasses%2Finterfaces%2Fregistry%2Fsocket%2Fclass_RegisterableSocket.php;h=6a93f752fb0d7c437d006055709650263951124a;hb=38b72ffe74c133db5dfe999187de21e5eebf180f;hp=14efd131c6c9966e5499c988bd1f357d03c5c8ed;hpb=c89cdd982baa6d3941f829f3916785e7069c4214;p=core.git diff --git a/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php b/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php index 14efd131..6a93f752 100644 --- 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 + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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.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,33 +23,41 @@ */ 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 $protocolInstance An instance of a ProtocolHandler class + * @param $protocolInstance An instance of a HandleableProtocol 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 (ProtocolHandler $protocolInstance, $socketResource); + function isSocketRegistered (HandleableProtocol $protocolInstance, $socketResource); /** * Registeres given socket for listener or throws an exception if it is already registered * - * @param $protocolInstance An instance of a ProtocolHandler 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 (ProtocolHandler $protocolInstance, $socketResource); + function registerSocket (HandleableProtocol $protocolInstance, $socketResource); /** * Getter for given listener's socket resource * - * @param $protocolInstance An instance of a ProtocolHandler 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 getSocketResource (ProtocolHandler $protocolInstance); + function getRegisteredSocketResource (HandleableProtocol $protocolInstance); + + /** + * "Getter" for protocol/connection instance from given package data + * + * @param $packageData Raw package data + * @return $protocolInstance An instance of a HandleableProtocol class + */ + function getHandlerInstanceFromPackageData (array $packageData); } // [EOF]