Decorators for hub/client listeners added

[hub.git] / application / hub / main / listener / udp / decorators / class_ClientUdpListenerDecorator.php

diff --git a/application/hub/main/listener/udp/decorators/class_ClientUdpListenerDecorator.php b/application/hub/main/listener/udp/decorators/class_ClientUdpListenerDecorator.php
new file mode 100644 (file)
index 0000000..554fac9
--- /dev/null
+++ b/application/hub/main/listener/udp/decorators/class_ClientUdpListenerDecorator.php
@@ -0,0 +1,64 @@
+<?php
+/**
+ * A decorator for the UdpListener to communicate to clients
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Client Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class ClientUdpListenerDecorator extends BaseListenerDecorator implements Listenable {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+       }
+
+       /**
+        * Creates an instance of this class
+        *
+        * @param       $listenerInstance       A Listener instance
+        * @return      $decoratorInstance      An instance a prepared listener decorator class
+        */
+       public final static function createClientUdpListenerDecorator (Listenable $listenerInstance) {
+               // Get new instance
+               $decoratorInstance = new ClientUdpListenerDecorator();
+
+               // Set the application instance
+               $decoratorInstance->setListenerInstance($listenerInstance);
+
+               // Return the prepared instance
+               return $decoratorInstance;
+       }
+
+       /**
+        * Initializes the listener by setting up the required socket server
+        *
+        * @return      void
+        * @todo        0% done
+        */
+       public function initListener() {
+               $this->partialStub('Need to implement this method.');
+       }
+}
+
+// [EOF]
+?>