3 * A decorator for the UdpListener to communicate to hubs
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub 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 HubUdpListenerDecorator extends BaseListenerDecorator implements Listenable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setListenerType('hub');
39 * Creates an instance of this class
41 * @param $listenerInstance A Listener instance
42 * @return $decoratorInstance An instance a prepared listener decorator class
44 public static final function createHubUdpListenerDecorator (Listenable $listenerInstance) {
46 $decoratorInstance = new HubUdpListenerDecorator();
48 // Set the application instance
49 $decoratorInstance->setListenerInstance($listenerInstance);
51 // Return the prepared instance
52 return $decoratorInstance;
56 * Initializes the listener by setting up the required socket server
60 public function initListener () {
61 $this->partialStub('WARNING: This method should not be called.');
65 * "Listens" for incoming network packages
69 public function doListen () {
70 // Handle generic UDP package first
71 $this->getListenerInstance()->doListen();
73 // Handle hub UDP package
74 $this->partialStub('Need to handle hub UDP package.');
78 * Checks wether the listener would accept the given package data array
80 * @param $packageData Raw package data
81 * @return $accepts Wether this listener does accept
83 public function ifListenerAcceptsPackageData (array $packageData) {
84 // Get a tags instance
85 $tagsInstance = PackageTagsFactory::createPackageTagsInstance();
87 // So is the package accepted with this listener?
88 $accepts = $tagsInstance->ifPackageDataIsAcceptedByListener($packageData, $this);