3 * A decorator for the SocketFileListener to communicate to hubs
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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 SocketFileListenerDecorator extends BaseListenerDecorator implements Listenable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set listener type and protocol name
35 $this->setListenerType('hub');
36 $this->setProtocolName('tcp');
40 * Creates an instance of this class
42 * @param $listenerInstance A Listener instance
43 * @return $decoratorInstance An instance a prepared listener decorator class
45 public static final function createSocketFileListenerDecorator (Listenable $listenerInstance) {
47 $decoratorInstance = new SocketFileListenerDecorator();
49 // Set the application instance
50 $decoratorInstance->setListenerInstance($listenerInstance);
52 // Return the prepared instance
53 return $decoratorInstance;
57 * Initializes the listener by setting up the required socket server
61 public function initListener () {
62 $this->partialStub('WARNING: This method should not be called.');
66 * "Listens" for incoming network packages
70 public function doListen () {
71 // Handle generic TCP package
72 $this->getListenerInstance()->doListen();
74 // Handle hub TCP package
75 $this->partialStub('Need to handle hub TCP package.');
79 * Checks whether the listener would accept the given package data array
81 * @param $packageData Raw package data
82 * @return $accepts Whether this listener does accept
84 public function ifListenerAcceptsPackageData (array $packageData) {
85 // Get a tags instance
86 $tagsInstance = PackageTagsFactory::createPackageTagsInstance();
88 // So is the package accepted with this listener?
89 $accepts = $tagsInstance->ifPackageDataIsAcceptedByListener($packageData, $this);