application/hub/classes/states/node/active/class_NodeActiveState.php

   1 <?php
   2 /**
   3  * An active node state class
   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 NodeActiveState extends BaseNodeState implements Stateable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set state name
  35                 $this->setStateName('active');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @return      $stateInstance  An instance of a Stateable class
  42          */
  43         public static final function createNodeActiveState () {
  44                 // Get new instance
  45                 $stateInstance = new NodeActiveState();
  46
  47                 // Get node instance and set 'active' flag
  48                 NodeObjectFactory::createNodeInstance()->enableIsActive();
  49
  50                 // Return the prepared instance
  51                 return $stateInstance;
  52         }
  53
  54         /**
  55          * State change for if the node got announced to it's upper hubs
  56          *
  57          * @return      void
  58          */
  59         public function nodeAnnouncingToUpperHubs () {
  60                 // Create the new state instance
  61                 NodeStateFactory::createNodeStateInstanceByName('announcing');
  62         }
  63
  64         /**
  65          * State change for if the node has just connected to itself and
  66          * node/session id are both equal. The self-connect means that
  67          * the node possibly reachable from outside. This may require
  68          * confirmation by other peers.
  69          *
  70          * @return      void
  71          * @todo        We might want to move some calls to this method to fill it with life
  72          */
  73         public function nodeHasSelfConnected () {
  74                 // Create the new state instance
  75                 NodeStateFactory::createNodeStateInstanceByName('reachable');
  76         }
  77 }
  78
  79 // [EOF]
  80 ?>