3 namespace CoreFramework\Registry\Socket;
5 // Import framework stuff
6 use CoreFramework\Information\ShareableInfo;
7 use CoreFramework\Listener\Listenable;
8 use CoreFramework\Registry\Registerable;
11 * A class for registerable socket classes
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 interface RegisterableSocket extends Registerable {
34 * Checks whether given socket resource is registered. If $socketResource is
35 * false only the instance will be checked.
37 * @param $infoInstance An instance of a ShareableInfo class
38 * @param $socketResource A valid socket resource
39 * @return $isRegistered Whether the given socket resource is registered
41 function isSocketRegistered (ShareableInfo $infoInstance, $socketResource);
44 * Registeres given socket for listener or throws an exception if it is already registered
46 * @param $infoInstance An instance of a ShareableInfo class
47 * @param $socketResource A valid socket resource
49 * @throws SocketAlreadyRegisteredException If the given socket is already registered
51 function registerSocket (ShareableInfo $infoInstance, $socketResource);
54 * Getter for given listener's socket resource
56 * @param $listenerInstance An instance of a Listenable class
57 * @return $socketResource A valid socket resource
58 * @throws NoSocketRegisteredException If the requested socket is not registered
60 function getRegisteredSocketResource (Listenable $listenerInstance);
63 * "Getter" for info instance from given package data
65 * @param $packageData Raw package data
66 * @return $infoInstance An instance of a ShareableInfo class
68 function getInfoInstanceFromPackageData (array $packageData);