3 * An active node state class
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class NodeActiveState extends BaseNodeState implements Stateable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setStateName('active');
39 * Creates an instance of this class
41 * @param $nodeInstance An instance of a NodeHelper class
42 * @return $stateInstance An instance of a Stateable class
44 public static final function createNodeActiveState (NodeHelper $nodeInstance) {
46 $stateInstance = new NodeActiveState();
48 // Enable isActive flag in node instance
49 $nodeInstance->enableIsActive();
51 // Set the node instance
52 $stateInstance->setNodeInstance($nodeInstance);
54 // Return the prepared instance
55 return $stateInstance;
59 * State change for if the node got announced to it's upper hubs
63 public function nodeAnnouncingToUpperHubs () {
64 // Create the new state instance
65 NodeStateFactory::createNodeStateInstanceByName('announcing', $this->getNodeInstance());
69 * State change for if the node has just connected to itself and
70 * node/session id are both equal. The self-connect means that
71 * the node possibly reachable from outside. This may require
72 * confirmation by other peers.
75 * @todo We might want to move some calls to this method to fill it with life
77 public function nodeHasSelfConnected () {
78 // Create the new state instance
79 NodeStateFactory::createNodeStateInstanceByName('reachable', $this->getNodeInstance());