5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 class ???Listener extends BaseListener implements Listenable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set the protocol to !!!
35 $this->setProtocolName('!!!');
39 * Creates an instance of this class
41 * @return $listenerInstance An instance a prepared listener class
43 public final static function create???Listener () {
45 $listenerInstance = new ???Listener();
47 // Return the prepared instance
48 return $listenerInstance;
52 * Initializes the listener by setting up the required socket server
57 public function initListener() {
58 $this->partialStub('Need to implement this method.');
62 * "Listens" for incoming network packages
67 public function doListen() {
68 $this->partialStub('Need to implement this method.');
72 * Checks whether the listener would accept the given package data array
74 * @param $packageData Raw package data
75 * @return $accepts Whether this listener does accept
77 public function ifListenerAcceptsPackageData (array $packageData) {
78 $this->partialStub('Need to implement this method.') {
82 * Monitors incoming raw data from the handler and transfers it to the
83 * given receiver instance.
87 public function monitorIncomingRawData () {
88 $this->partialStub('Need to implement this method.') {
92 * Getter for connection type
94 * @return $connectionType Connection type for this listener
96 public function getConnectionType () {
97 $this->partialStub('Need to implement this method.') {