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