added files for database format-upgrade
[core.git] / inc / main / classes / listener / class_
1 <?php
2 /**
3  * A ??? listener
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.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.ship-simu.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 class ???Listener extends BaseListener implements Listenable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33
34                 // Set the protocol to !!!
35                 $this->setProtocolName('!!!');
36         }
37
38         /**
39          * Creates an instance of this class
40          *
41          * @return      $listenerInstance       An instance a prepared listener class
42          */
43         public final static function create???Listener () {
44                 // Get new instance
45                 $listenerInstance = new ???Listener();
46
47                 // Return the prepared instance
48                 return $listenerInstance;
49         }
50
51         /**
52          * Initializes the listener by setting up the required socket server
53          *
54          * @return      void
55          * @todo        0% done
56          */
57         public function initListener() {
58                 $this->partialStub('Need to implement this method.');
59         }
60
61         /**
62          * "Listens" for incoming network packages
63          *
64          * @return      void
65          * @todo        0% done
66          */
67         public function doListen() {
68                 $this->partialStub('Need to implement this method.');
69         }
70
71         /**
72          * Checks whether the listener would accept the given package data array
73          *
74          * @param       $packageData    Raw package data
75          * @return      $accepts                Whether this listener does accept
76          */
77         public function ifListenerAcceptsPackageData (array $packageData) {
78                 $this->partialStub('Need to implement this method.') {
79         }
80
81         /**
82          * Monitors incoming raw data from the handler and transfers it to the
83          * given receiver instance.
84          *
85          * @return      void
86          */
87         public function monitorIncomingRawData () {
88                 $this->partialStub('Need to implement this method.') {
89         }
90
91         /**
92          * Getter for connection type
93          *
94          * @return      $connectionType         Connection type for this listener
95          */
96         public function getConnectionType () {
97                 $this->partialStub('Need to implement this method.') {
98         }
99
100 }