application/hub/main/tasks/node/decoder/class_NodePackageDecoderTask.php

   1 <?php
   2 /**
   3  * A PackageDecoder node-task
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class NodePackageDecoderTask extends BaseTask implements Taskable, Visitable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $taskInstance   An instance of a Visitable class
  39          */
  40         public final static function createNodePackageDecoderTask () {
  41                 // Get new instance
  42                 $taskInstance = new NodePackageDecoderTask();
  43
  44                 // Get a chunk handler instance
  45                 $handlerInstance = ChunkHandlerFactory::createChunkHandlerInstance();
  46
  47                 // Get the stacker from it, we don't need the handler here
  48                 $stackerInstance = $handlerInstance->getStackerInstance();
  49
  50                 // Get a decoder instance
  51                 $decoderInstance = ObjectFactory::createObjectByConfiguredName('package_decoder_class', array($stackerInstance));
  52
  53                 // ... and also set the decoder instance here
  54                 $taskInstance->setDecoderInstance($decoderInstance);
  55
  56                 // Return the prepared instance
  57                 return $taskInstance;
  58         }
  59
  60         /**
  61          * Accepts the visitor to process the visit "request"
  62          *
  63          * @param       $visitorInstance        An instance of a Visitor class
  64          * @return      void
  65          * @todo        Maybe visit some sub-objects
  66          */
  67         public function accept (Visitor $visitorInstance) {
  68                 // Visit this task
  69                 $visitorInstance->visitTask($this);
  70         }
  71
  72         /**
  73          * Executes the task
  74          *
  75          * @return      void
  76          */
  77         public function executeTask () {
  78                 // Check if the stacker has some entries left
  79                 if ($this->getDecoderInstance()->ifUnhandledRawPackageDataLeft()) {
  80                         // Then handle it
  81                         $this->getDecoderInstance()->handleRawPackageData();
  82                 } elseif ($this->getDecoderInstance()->ifDeocedPackagesLeft()) {
  83                         // Some decoded packages have arrived (for this peer)
  84                         $this->getDecoderInstance()->handleDecodedPackage();
  85                 }
  86         }
  87 }
  88
  89 // [EOF]
  90 ?>