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 - 2014 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                 // Get a singleton network package instance
  45                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
  46
  47                 // And set it in this task
  48                 $taskInstance->setPackageInstance($packageInstance);
  49
  50                 // Return the prepared instance
  51                 return $taskInstance;
  52         }
  53
  54         /**
  55          * Accepts the visitor to process the visitor
  56          *
  57          * @param       $visitorInstance        An instance of a Visitor class
  58          * @return      void
  59          * @todo        Also visit some sub-objects?
  60          */
  61         public function accept (Visitor $visitorInstance) {
  62                 // Visit this task
  63                 $visitorInstance->visitTask($this);
  64         }
  65
  66         /**
  67          * Executes the task
  68          *
  69          * @return      void
  70          */
  71         public function executeTask () {
  72                 // "Cache" package instance
  73                 $packageInstance = $this->getPackageInstance();
  74
  75                 // Do we have something to deliver?
  76                 if ($packageInstance->isEncodedDataPending()) {
  77                         // Sent encoded (raw) data
  78                         $packageInstance->sendEncodedData();
  79                 } elseif ($packageInstance->isPackageWaitingForDelivery()) {
  80                         // Sent it finally out
  81                         $packageInstance->sendWaitingPackage();
  82                 } elseif ($packageInstance->isPackageDeclared()) {
  83                         // Prepare package for delivery
  84                         $packageInstance->processDeclaredPackage();
  85                 } elseif ($packageInstance->isPackageEnqueued()) {
  86                         // Okay, then deliver (better discover its recipients) this package
  87                         $packageInstance->declareEnqueuedPackage();
  88                 }
  89         }
  90 }
  91
  92 // [EOF]
  93 ?>