3 * A decorator for the UdpListener to communicate to clients
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Client 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 ClientUdpListenerDecorator extends BaseListenerDecorator implements Listenable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @param $listenerInstance A Listener instance
39 * @return $decoratorInstance An instance a prepared listener decorator class
41 public final static function createClientUdpListenerDecorator (Listenable $listenerInstance) {
43 $decoratorInstance = new ClientUdpListenerDecorator();
45 // Set the application instance
46 $decoratorInstance->setListenerInstance($listenerInstance);
48 // Return the prepared instance
49 return $decoratorInstance;
53 * Initializes the listener by setting up the required socket server
57 public function initListener() {
58 $this->partialStub('WARNING: This method should not be called.');
62 * "Listens" for incoming network packages
66 public function doListen() {
67 // Handle generic UDP packages first
68 $this->getListenerInstance()->doListen();
70 // Handle this client UDP package
71 $this->partialStub('Need to handle client UDP package.');