added files for database format-upgrade
[core.git] / inc / main / interfaces / registry / socket / class_RegisterableSocket.php
1 <?php
2 /**
3  * A class for registerable socket classes
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 interface RegisterableSocket extends Registerable {
25         /**
26          * Checks whether given socket resource is registered. If $socketResource is
27          * FALSE only the instance will be checked.
28          *
29          * @param       $infoInstance           An instance of a ShareableInfo class
30          * @param       $socketResource         A valid socket resource
31          * @return      $isRegistered           Whether the given socket resource is registered
32          */
33         function isSocketRegistered (ShareableInfo $infoInstance, $socketResource);
34
35         /**
36          * Registeres given socket for listener or throws an exception if it is already registered
37          *
38          * @param       $infoInstance   An instance of a ShareableInfo class
39          * @param       $socketResource         A valid socket resource
40          * @return      void
41          * @throws      SocketAlreadyRegisteredException        If the given socket is already registered
42          */
43         function registerSocket (ShareableInfo $infoInstance, $socketResource);
44
45         /**
46          * Getter for given listener's socket resource
47          *
48          * @param       $listenerInstance       An instance of a Listenable class
49          * @return      $socketResource         A valid socket resource
50          * @throws      NoSocketRegisteredException             If the requested socket is not registered
51          */
52         function getRegisteredSocketResource (Listenable $listenerInstance);
53
54         /**
55          * "Getter" for info instance from given package data
56          *
57          * @param       $packageData    Raw package data
58          * @return      $infoInstance   An instance of a ShareableInfo class
59          */
60         function getInfoInstanceFromPackageData (array $packageData);
61
62 }