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

   1 <?php
   2 /**
   3  * A NetworkPackageWriter 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 NetworkPackageWriterTask 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 createNetworkPackageWriterTask () {
  41                 // Get new instance
  42                 $taskInstance = new NetworkPackageWriterTask();
  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 deliver?
  70                 if ($packageInstance->isEncodedDataPending()) {
  71                         // Sent encoded (raw) data
  72                         $packageInstance->sendEncodedData();
  73                 } elseif ($packageInstance->isPackageWaitingForDelivery()) {
  74                         // Sent it finally out
  75                         $packageInstance->sendWaitingPackage();
  76                 } elseif ($packageInstance->isPackageDeclared()) {
  77                         // Prepare package for delivery
  78                         $packageInstance->processDeclaredPackage();
  79                 } elseif ($packageInstance->isPackageEnqueued()) {
  80                         // Okay, then deliver (better discover its recipients) this package
  81                         $packageInstance->declareEnqueuedPackage();
  82                 }
  83         }
  84
  85         /**
  86          * Shuts down the task
  87          *
  88          * @return      void
  89          * @todo        0% done
  90          */
  91         public function doShutdown () {
  92                 self::createDebugInstance(__CLASS__)->debugOutput('TASK[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down...');
  93         }
  94 }
  95
  96 // [EOF]
  97 ?>