Updated 'core'.
[hub.git] / application / hub / main / tasks / node / listener / class_NodeSocketListenerTask.php
1 <?php
2 /**
3  * A HubSocketListener task
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 NodeSocketListenerTask 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 createNodeSocketListenerTask () {
41                 // Get new instance
42                 $taskInstance = new NodeSocketListenerTask();
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                 // Get the node instance from registry
56                 $nodeInstance = NodeObjectFactory::createNodeInstance();
57
58                 // Visit the pool listener task
59                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('LISTENER-TASK[' . __METHOD__ . ':' . __LINE__ . ']: Going to visit object ' . $nodeInstance->getListenerPoolInstance()->__toString() . ' ...');
60                 $nodeInstance->getListenerPoolInstance()->accept($visitorInstance);
61
62                 // Visit this task
63                 // @TODO Do we need to visit this task? $visitorInstance->visitTask($this);
64         }
65
66         /**
67          * Executes the task
68          *
69          * @return      void
70          * @todo        0% done
71          */
72         public function executeTask () {
73                 $this->partialStub('Unimplemented task.');
74         }
75
76         /**
77          * Shuts down the task
78          *
79          * @return      void
80          * @todo        0% done
81          */
82         public function doShutdown () {
83                 self::createDebugInstance(__CLASS__)->debugOutput('TASK[' . __METHOD__ . ':' . __LINE__ . ']: Shutting down...');
84         }
85 }
86
87 // [EOF]
88 ?>