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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Task\IdleLoop;
   4
   5 /**
   6  * A IdleLoop task
   7  *
   8  * @author              Roland Haeder <webmaster@shipsimu.org>
   9  * @version             0.0.0
  10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  11  * @license             GNU GPL 3.0 or any newer version
  12  * @link                http://www.shipsimu.org
  13  *
  14  * This program is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26  */
  27 class IdleLoopTask extends BaseTask implements Taskable, Visitable {
  28         /**
  29          * Idle loop time
  30          */
  31         private $idleTime = 0;
  32
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         protected function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41
  42                 // Init idle loop time from config ("cache" it here)
  43                 $this->idleTime = $this->getConfigInstance()->getConfigEntry('idle_loop_time');
  44         }
  45
  46         /**
  47          * Creates an instance of this class
  48          *
  49          * @return      $taskInstance   An instance of a Taskable/Visitable class
  50          */
  51         public static final function createIdleLoopTask () {
  52                 // Get new instance
  53                 $taskInstance = new IdleLoopTask();
  54
  55                 // Return the prepared instance
  56                 return $taskInstance;
  57         }
  58
  59         /**
  60          * Accepts the visitor to process the visitor
  61          *
  62          * @param       $visitorInstance        An instance of a Visitor class
  63          * @return      void
  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                 // Idle here a little
  77                 $this->idle($this->idleTime);
  78         }
  79
  80         /**
  81          * Shutdown this task, this does nothing here, just supply the method.
  82          *
  83          * @return      void
  84          */
  85         public function doShutdown () {
  86                 // Debug message
  87                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('TASK[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down...');
  88         }
  89
  90 }