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

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