*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
/**
* Query connector instance
*/
- private $queryConnectorInstance = null;
+ private $queryConnectorInstance = NULL;
/**
* Queue connector instance
*/
- private $queueConnectorInstance = null;
+ private $queueConnectorInstance = NULL;
/**
- * Listener pool instance
- */
- private $listenerPoolInstance = null;
-
- /**
- * Wether this node is anncounced (KEEP ON false!)
+ * Whether this node is anncounced (KEEP ON false!)
* @deprecated
*/
private $hubIsAnnounced = false;
/**
- * Wether this hub is active
+ * Whether this hub is active (default: false)
*/
private $isActive = false;
+ /**
+ * Whether this node accepts announcements (default: false)
+ */
+ private $acceptAnnouncements = false;
+
/**
* Protected constructor
*
* @return void
*/
private function initState() {
- // Get the state factory and create the initial state, we don't need
- // the state instance here
+ /*
+ * Get the state factory and create the initial state, we don't need
+ * the state instance here
+ */
NodeStateFactory::createNodeStateInstanceByName('init', $this);
}
- /**
- * Setter for node id
- *
- * @param $nodeId Our new node id
- * @return void
- */
- private final function setNodeId ($nodeId) {
- // Set it config now
- $this->getConfigInstance()->setConfigEntry('node_id', (string) $nodeId);
- }
-
- /**
- * Getter for node id
- *
- * @return $nodeId Current node id
- */
- private final function getNodeId () {
- // Get it from config
- return $this->getConfigInstance()->getConfigEntry('node_id');
- }
-
- /**
- * Setter for listener pool instance
- *
- * @param $listenerPoolInstance Our new listener pool instance
- * @return void
- */
- private final function setListenerPoolInstance (PoolableListener $listenerPoolInstance) {
- $this->listenerPoolInstance = $listenerPoolInstance;
- }
-
- /**
- * Getter for listener pool instance
- *
- * @return $listenerPoolInstance Our current listener pool instance
- */
- public final function getListenerPoolInstance () {
- return $this->listenerPoolInstance;
- }
-
- /**
- * Setter for session id
- *
- * @param $sessionId Our new session id
- * @return void
- */
- private final function setSessionId ($sessionId) {
- $this->getConfigInstance()->setConfigEntry('session_id', (string) $sessionId);
- }
-
- /**
- * Getter for session id
- *
- * @return $sessionId Current session id
- */
- public final function getSessionId () {
- return $this->getConfigInstance()->getConfigEntry('session_id');
- }
-
/**
* Setter for query instance
*
}
/**
- * Checks wether the given IP address matches one of the bootstrapping nodes
+ * Checks whether the given IP address matches one of the bootstrapping nodes
*
* @param $remoteAddr IP address to checkout against our bootstrapping list
- * @return $isFound Wether the IP is found
+ * @return $isFound Whether the IP is found
*/
protected function ifAddressMatchesBootstrappingNodes ($remoteAddr) {
// By default nothing is found
$isFound = false;
// Run through all configured IPs
- foreach (explode(',', $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) {
+ foreach (explode(BaseHubSystem::BOOTSTRAP_NODES_SEPARATOR, $this->getConfigInstance()->getConfigEntry('hub_bootstrap_nodes')) as $ipPort) {
// Split it up in IP/port
$ipPortArray = explode(':', $ipPort);
// Output all lines
$this->debugOutput(' ');
$this->debugOutput($app->getAppName() . ' v' . $app->getAppVersion() . ' - ' . $this->getRequestInstance()->getRequestElement('mode') . ' mode active');
- $this->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2011 Hub Developer Team');
+ $this->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2012 Hub Developer Team');
$this->debugOutput(' ');
$this->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
$this->debugOutput('This is free software, and you are welcome to redistribute it under certain');
$this->debugOutput('HUB-Announcement: START (taskInstance=' . $taskInstance->__toString(). ')');
// Get a helper instance
- $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class', array($this));
+ $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class');
// Load the announcement descriptor
$helperInstance->loadDescriptorXml();
- // Set some dummy configuration entries, e.g. node_status
- $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName());
-
// Compile all variables
$helperInstance->getTemplateInstance()->compileConfigInVariables();
// Load the descriptor (XML) file
$helperInstance->loadDescriptorXml();
+ // Compile all variables
+ $helperInstance->getTemplateInstance()->compileConfigInVariables();
+
// And send the package away
$helperInstance->sendPackage($this);
* @return void
*/
public function activateNode (Requestable $requestInstance, Responseable $responseInstance) {
- // Checks wether a listener is still active and shuts it down if one
+ // Checks whether a listener is still active and shuts it down if one
// is still listening.
- if (($this->determineIfListenerIsActive()) && ($this->getIsActive())) {
+ if (($this->determineIfListenerIsActive()) && ($this->isNodeActive())) {
// Shutdown them down before they can hurt anything
$this->shutdownListenerPool();
} // END - if
// Setup address and port
$listenerInstance->setListenAddressByConfiguration('node_listen_addr');
- if ($this instanceof HubBootNode) {
- // Bootstrap have different listening port
- $listenerInstance->setListenPortByConfiguration('boot_node_tcp_listen_port');
- } else {
- // All other nodes use the default port
- $listenerInstance->setListenPortByConfiguration('node_tcp_listen_port');
- }
+
+ /*
+ * All nodes can now use the same configuration entry because it can be
+ * customized in config-local.php.
+ */
+ $listenerInstance->setListenPortByConfiguration('node_tcp_listen_port');
// Initialize the listener
$listenerInstance->initListener();
$this->getListenerPoolInstance()->addListener($decoratorInstance);
// Get a decorator class
- $decoratorInstance = ObjectFactory::createObjectByConfiguredName('peer_tcp_listener_class', array($listenerInstance));
+ $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_tcp_listener_class', array($listenerInstance));
// Add this listener to the pool
$this->getListenerPoolInstance()->addListener($decoratorInstance);
// Setup address and port
$listenerInstance->setListenAddressByConfiguration('node_listen_addr');
- if ($this instanceof HubBootNode) {
- // Bootstrap have different listening port
- $listenerInstance->setListenPortByConfiguration('boot_node_udp_listen_port');
- } else {
- // All other nodes use the default port
- $listenerInstance->setListenPortByConfiguration('node_udp_listen_port');
- }
+
+ /*
+ * All nodes can now use the same configuration entry because it can be
+ * customized in config-local.php.
+ */
+ $listenerInstance->setListenPortByConfiguration('node_udp_listen_port');
// Initialize the listener
$listenerInstance->initListener();
$this->getListenerPoolInstance()->addListener($decoratorInstance);
// Get a decorator class
- $decoratorInstance = ObjectFactory::createObjectByConfiguredName('peer_udp_listener_class', array($listenerInstance));
+ $decoratorInstance = ObjectFactory::createObjectByConfiguredName('client_udp_listener_class', array($listenerInstance));
// Add this listener to the pool
$this->getListenerPoolInstance()->addListener($decoratorInstance);
/**
* Getter for isActive attribute
*
- * @return $isActive Wether the hub is active
+ * @return $isActive Whether the hub is active
*/
- public final function getIsActive () {
+ public final function isNodeActive () {
return $this->isActive;
}
/**
* Enables (default) or disables isActive flag
*
- * @param $isActive Wether the hub is active
+ * @param $isActive Whether the hub is active
* @return void
*/
public final function enableIsActive ($isActive = true) {
$this->isActive = (bool) $isActive;
}
+ /**
+ * Checks whether this node accepts announcements
+ *
+ * @return $acceptAnnouncements Whether this node accepts announcements
+ */
+ public final function isAcceptingAnnouncements () {
+ // Check it (this node must be active and not shutdown!)
+ $acceptAnnouncements = (($this->acceptAnnouncements === true) && ($this->isNodeActive()));
+
+ // Return it
+ return $acceptAnnouncements;
+ }
+
+ /**
+ * Enables whether this node accepts announcements
+ *
+ * @param $acceptAnnouncements Whether this node accepts announcements (default: true)
+ * @return void
+ */
+ protected final function enableAcceptingAnnouncements ($acceptAnnouncements = true) {
+ $this->acceptAnnouncements = $acceptAnnouncements;
+ }
+
+
/**
* "Getter for address:port combination
*
// Return it
return $addressPort;
}
+
+ /**
+ * Updates/refreshes node data (e.g. state).
+ *
+ * @return void
+ * @todo Find more to do here
+ */
+ public function updateNodeData () {
+ // Set some dummy configuration entries, e.g. node_status
+ $this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName());
+ }
}
// [EOF]
projects / hub.git / blobdiff