]> git.mxchange.org Git - hub.git/blob - application/hub/main/nodes/class_
02a4cbd631bfc3a79f449d572604a759edfc81c1
[hub.git] / application / hub / main / nodes / class_
1 <?php
2 /**
3  * A hub-node class for the '???' mode
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 Hub???Node extends BaseHubNode implements NodeHelper, Registerable {
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 hub-node class
37          *
38          * @param       $requestInstance        An instance of a Requestable class
39          * @return      $nodeInstance           An instance of this hub-node class
40          */
41         public final static function createHub???Node (Requestable $requestInstance) {
42                 // Get a new instance
43                 $nodeInstance = new Hub???Node();
44
45                 // Set the request instance
46                 $nodeInstance->setRequestInstance($requestInstance);
47
48                 // Return the instance
49                 return $nodeInstance;
50         }
51
52         /**
53          * Method to "bootstrap" the node. This step does also apply provided
54          * command-line arguments stored in the request instance. The regular node
55          * should communicate with the bootstrap-nodes at this point.
56          *
57          * @return      void
58          * @todo        Implement this method
59          */
60         public function doBootstrapping () {
61                 // Call generic (parent) bootstrapping method first
62                 parent::doGenericBootstrapping();
63                 $this->partialStub('Please implement this method.');
64         }
65
66         /**
67          * Initializes hub-specific queues
68          *
69          * @return      void
70          * @todo        Implement this method
71          */
72         public function initQueues () {
73                 $this->partialStub('Please implement this method.');
74         }
75
76         /**
77          * Add some node-specific filters
78          *
79          * @return      void
80          */
81         public function addExtraHubFilters () {
82                 // Add some filters here
83         }
84 }
85
86 //
87 ?>