application/hub/main/tasks/network/class_NetworkPackageReaderTask.php

   1 <?php
   2 /**
   3  * A NetworkPackageReader 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 NetworkPackageReaderTask 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          * @param       $poolInstance   An instance of a PoolableListener class
  39          * @return      $taskInstance   An instance of a Taskable/Visitable class
  40          */
  41         public static final function createNetworkPackageReaderTask (PoolableListener $poolInstance) {
  42                 // Get new instance
  43                 $taskInstance = new NetworkPackageReaderTask();
  44
  45                 // Set the listener instance here
  46                 $taskInstance->setListenerPoolInstance($poolInstance);
  47
  48                 // Get a singleton network package instance
  49                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
  50
  51                 // And set it in this task
  52                 $taskInstance->setPackageInstance($packageInstance);
  53
  54                 // Return the prepared instance
  55                 return $taskInstance;
  56         }
  57
  58         /**
  59          * Accepts the visitor to process the visitor
  60          *
  61          * @param       $visitorInstance        An instance of a Visitor class
  62          * @return      void
  63          * @todo        Also visit some sub-objects?
  64          */
  65         public function accept (Visitor $visitorInstance) {
  66                 // Visit this task
  67                 $visitorInstance->visitTask($this);
  68         }
  69
  70         /**
  71          * Executes the task
  72          *
  73          * @return      void
  74          */
  75         public function executeTask () {
  76                 // Do we have something to handle?
  77                 if ($this->getPackageInstance()->isProcessedMessagePending()) {
  78                         /*
  79                          * A previously proccessed message is waiting for being
  80                          * "interpreted". This is done by trying to find a configuration
  81                          * entry based on 'message_type' element.
  82                          */
  83                         $this->getPackageInstance()->handleProcessedMessage();
  84                 } elseif ($this->getPackageInstance()->isNewMessageArrived()) {
  85                         /*
  86                          * A fully "decoded" message has been received and added for being
  87                          * processed. Processing a message should not take long, so mostly
  88                          * this step involves reading all data through a XML template engine
  89                          * as "XML variables" from the content (which must be a well-formed
  90                          * XML) and then pushing it on the next stack "processed messages".
  91                          */
  92                         $this->getPackageInstance()->handleNewlyArrivedMessage();
  93                 } elseif ($this->getPackageInstance()->isIncomingRawDataHandled()) {
  94                         /*
  95                          * Incoming decoded data has been handled (see below) so it needs to
  96                          * be assembled back to a "package array". Please see NetworkPackage
  97                          * for further details (what array elements are required et cetera).
  98                          */
  99                         $this->getPackageInstance()->assembleDecodedDataToPackage();
 100                 } elseif ($this->getPackageInstance()->isNewRawDataPending($this->getListenerPoolInstance())) {
 101                         // Raw, decoded data has been received
 102                         $this->getPackageInstance()->handleIncomingDecodedData();
 103                 } elseif ($this->getPackageInstance()->ifAssemblerHasPendingDataLeft()) {
 104                         // Handle any pending data from the package assembler
 105                         $this->getPackageInstance()->handleAssemblerPendingData();
 106                 } // END - if
 107         }
 108 }
 109
 110 // [EOF]
 111 ?>