Copyright notice updated

[hub.git] / application / hub / main / listener / tcp / decorators / class_ClientTcpListenerDecorator.php

diff --git a/application/hub/main/listener/tcp/decorators/class_ClientTcpListenerDecorator.php b/application/hub/main/listener/tcp/decorators/class_ClientTcpListenerDecorator.php
index a474ccbca41bcae8a7673d0cfd6704a4a0632aa9..ef42a0ebe0376195495782f31873b656af178af1 100644 (file)
--- a/application/hub/main/listener/tcp/decorators/class_ClientTcpListenerDecorator.php
+++ b/application/hub/main/listener/tcp/decorators/class_ClientTcpListenerDecorator.php
@@ -1,10 +1,10 @@
 <?php
 /**
- * A decorator for the TcpListener to communicate to clients
+ * A decorator for the TcpListener to communicate to peers
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Client Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -30,6 +30,9 @@ class ClientTcpListenerDecorator extends BaseListenerDecorator implements Listen
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
+
+               // Set listener type
+               $this->setListenerType('peer');
        }
 
        /**
@@ -38,7 +41,7 @@ class ClientTcpListenerDecorator extends BaseListenerDecorator implements Listen
         * @param       $listenerInstance       A Listener instance
         * @return      $decoratorInstance      An instance a prepared listener decorator class
         */
-       public final static function createClientTcpListenerDecorator (Listenable $listenerInstance) {
+       public static final function createClientTcpListenerDecorator (Listenable $listenerInstance) {
                // Get new instance
                $decoratorInstance = new ClientTcpListenerDecorator();
 
@@ -53,10 +56,39 @@ class ClientTcpListenerDecorator extends BaseListenerDecorator implements Listen
         * 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.');
+       public function initListener () {
+               $this->partialStub('WARNING: This method should not be called.');
+       }
+
+       /**
+        * "Listens" for incoming network packages
+        *
+        * @return      void
+        */
+       public function doListen () {
+               // Handle generic TCP package
+               $this->getListenerInstance()->doListen();
+
+               // Handle peer TCP package
+               $this->partialStub('Need to handle peer TCP package.');
+       }
+
+       /**
+        * Checks whether the listener would accept the given package data array
+        *
+        * @param       $packageData    Raw package data
+        * @return      $accepts                Whether this listener does accept
+        */
+       public function ifListenerAcceptsPackageData (array $packageData) {
+               // Get a tags instance
+               $tagsInstance = PackageTagsFactory::createPackageTagsInstance();
+
+               // So is the package accepted with this listener?
+               $accepts = $tagsInstance->ifPackageDataIsAcceptedByListener($packageData, $this);
+
+               // Return the result
+               return $accepts;
        }
 }