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

   1 <?php
   2 /**
   3  * A NetworkPackageReader task
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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          * @return      $taskInstance   An instance of a Taskable/Visitable class
  39          */
  40         public static final function createNetworkPackageReaderTask () {
  41                 // Get new instance
  42                 $taskInstance = new NetworkPackageReaderTask();
  43
  44                 // Return the prepared instance
  45                 return $taskInstance;
  46         }
  47
  48         /**
  49          * Accepts the visitor to process the visitor
  50          *
  51          * @param       $visitorInstance        An instance of a Visitor class
  52          * @return      void
  53          * @todo        Also visit some sub-objects?
  54          */
  55         public function accept (Visitor $visitorInstance) {
  56                 // Visit this task
  57                 $visitorInstance->visitTask($this);
  58         }
  59
  60         /**
  61          * Executes the task
  62          *
  63          * @return      void
  64          */
  65         public function executeTask () {
  66                 // "Cache" package instance
  67                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
  68
  69                 // Do we have something to handle?
  70                 if ($packageInstance->isProcessedMessagePending()) {
  71                         /*
  72                          * A previously proccessed message is waiting for being
  73                          * "interpreted". This is done by trying to find a configuration
  74                          * entry based on 'message_type' element.
  75                          */
  76                         $packageInstance->handleProcessedMessage();
  77                 } elseif ($packageInstance->isNewMessageArrived()) {
  78                         /*
  79                          * A fully "decoded" message has been received and added for being
  80                          * processed. Processing a message should not take long, so mostly
  81                          * this step involves reading all data through a XML template engine
  82                          * as "XML variables" from the content (which must be a well-formed
  83                          * XML) and then pushing it on the next stack "processed messages".
  84                          */
  85                         $packageInstance->handleNewlyArrivedMessage();
  86                 } elseif ($packageInstance->isIncomingRawDataHandled()) {
  87                         /*
  88                          * Incoming decoded data has been handled (see below) so it needs to
  89                          * be assembled back to a "package array". Please see NetworkPackage
  90                          * for further details (what array elements are required et cetera).
  91                          */
  92                         $packageInstance->assembleDecodedDataToPackage();
  93                 } elseif ($packageInstance->ifMultipleMessagesPending()) {
  94                         /*
  95                          * Some raw data contained multiple messages which where now splitted.
  96                          */
  97                         $packageInstance->handleMultipleMessages();
  98                 } elseif ($packageInstance->isNewRawDataPending()) {
  99                         // Raw, decoded data has been received
 100                         $packageInstance->handleIncomingDecodedData();
 101                 } elseif ($packageInstance->ifAssemblerHasPendingDataLeft()) {
 102                         // Handle any pending data from the package assembler
 103                         $packageInstance->handleAssemblerPendingData();
 104                 } // END - if
 105         }
 106
 107         /**
 108          * Shuts down the task
 109          *
 110          * @return      void
 111          * @todo        0% done
 112          */
 113         public function doShutdown () {
 114                 self::createDebugInstance(__CLASS__)->debugOutput('TASK[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down...');
 115         }
 116 }
 117
 118 // [EOF]
 119 ?>