inc/classes/main/tasks/idle/class_IdleLoopTask.php

   1 <?php
   2 /**
   3  * A IdleLoop task
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core 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 IdleLoopTask 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 createIdleLoopTask () {
  41                 // Get new instance
  42                 $taskInstance = new IdleLoopTask();
  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          */
  54         public function accept (Visitor $visitorInstance) {
  55                 // Visit this task
  56                 $visitorInstance->visitTask($this);
  57         }
  58
  59         /**
  60          * Executes the task
  61          *
  62          * @return      void
  63          */
  64         public function executeTask () {
  65                 // Idle here a little (2 milliseconds)
  66                 $this->idle(2);
  67         }
  68
  69         /**
  70          * Shutdown this task, this does nothing here, just supply the method.
  71          *
  72          * @return      void
  73          */
  74         public function doShutdown () {
  75                 // Debug message
  76                 self::createDebugInstance(__CLASS__)->debugOutput('IDLE-TASK[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down...');
  77         }
  78 }
  79
  80 // [EOF]
  81 ?>