3 * A class for registerable socket classes
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 interface RegisterableSocket extends Registerable {
26 * Checks whether given socket resource is registered. If $socketResource is
27 * FALSE only the instance will be checked.
29 * @param $protocolInstance An instance of a ProtocolHandler class
30 * @param $socketResource A valid socket resource
31 * @return $isRegistered Whether the given socket resource is registered
33 function isSocketRegistered (ProtocolHandler $protocolInstance, $socketResource);
36 * Registeres given socket for listener or throws an exception if it is already registered
38 * @param $protocolInstance An instance of a ProtocolHandler class
39 * @param $socketResource A valid socket resource
41 * @throws SocketAlreadyRegisteredException If the given socket is already registered
43 function registerSocket (ProtocolHandler $protocolInstance, $socketResource);
46 * Getter for given listener's socket resource
48 * @param $protocolInstance An instance of a ProtocolHandler class
49 * @return $socketResource A valid socket resource
50 * @throws NoSocketRegisteredException If the requested socket is not registered
52 function getRegisteredSocketResource (ProtocolHandler $protocolInstance);
55 * "Getter" for protocol/connection instance from given package data
57 * @param $packageData Raw package data
58 * @return $protocolInstance An instance of a ProtocolHandler class
60 function getHandlerInstanceFromPackageData (array $packageData);