*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class BaseHubNode extends BaseHubSystem implements Updateable {
+ /**
+ * Node types
+ */
+ const NODE_TYPE_BOOT = 'boot';
+ const NODE_TYPE_MASTER = 'master';
+ const NODE_TYPE_LIST = 'list';
+ const NODE_TYPE_REGULAR = 'regular';
+
// Exception constants
const EXCEPTION_HUB_ALREADY_ANNOUNCED = 0xe00;
/**
* Query connector instance
*/
- private $connectorInstance = null;
+ private $queryConnectorInstance = null;
+
+ /**
+ * Queue connector instance
+ */
+ private $queueConnectorInstance = null;
/**
* Listener pool instance
* @return void
*/
private final function setQueryConnectorInstance (Connectable $connectorInstance) {
- $this->connectorInstance = $connectorInstance;
+ $this->queryConnectorInstance = $connectorInstance;
}
/**
* @return $connectorInstance Our new query instance
*/
public final function getQueryConnectorInstance () {
- return $this->connectorInstance;
+ return $this->queryConnectorInstance;
+ }
+
+ /**
+ * Setter for queue instance
+ *
+ * @param $connectorInstance Our new queue instance
+ * @return void
+ */
+ private final function setQueueConnectorInstance (Connectable $connectorInstance) {
+ $this->queueConnectorInstance = $connectorInstance;
+ }
+
+ /**
+ * Getter for queue instance
+ *
+ * @return $connectorInstance Our new queue instance
+ */
+ public final function getQueueConnectorInstance () {
+ return $this->queueConnectorInstance;
}
/**
/**
* "Getter" for a printable state name
+ *
+ * @return $stateName Name of the node's state in a printable format
*/
public final function getPrintableState () {
// Default is 'null'
break;
} elseif ($ipPortArray[0] == $this->getConfigInstance()->getConfigEntry('node_listen_addr')) {
// IP matches listen address. At this point we really don't care
- // if we can also listen on that address!
+ // if we can really listen on that address
$isFound = true;
// Remember the port number
// 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, 2010 Hub Developer Team');
+ $this->debugOutput('Copyright (c) 2007 - 2008 Roland Haeder, 2009 - 2011 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');
* @param $responseInstance A Responseable class
* @return void
*/
- public function bootstrapAcquireHubId (Requestable $requestInstance, Responseable $responseInstance) {
+ public function bootstrapAcquireNodeId (Requestable $requestInstance, Responseable $responseInstance) {
// Get a wrapper instance
$wrapperInstance = ObjectFactory::createObjectByConfiguredName('node_info_db_wrapper_class');
// Get a crypto instance
$cryptoInstance = ObjectFactory::createObjectByConfiguredName('crypto_class');
- // Hash and encrypt the string so we become a "node id" aka Hub-Id
+ // Hash and encrypt the string so we become a node id (also documented as "hub id")
$this->setNodeId($cryptoInstance->hashString($cryptoInstance->encryptString($randomString)));
// Register the node id with our wrapper
// Run a test query
$this->getQueryConnectorInstance()->doTestQuery();
+ // Set the queue connector instance
+ $this->setQueueConnectorInstance(ObjectFactory::createObjectByConfiguredName('queue_connector_class', array($this)));
+
+ // Run a test queue
+ $this->getQueueConnectorInstance()->doTestQueue();
+
// Debug message
$this->debugOutput('BOOTSTRAP: Initialize queues: FINISHED');
}
/**
* Announces this hub to the upper (bootstrap or list) hubs. After this is
- * successfully done the given task is unregistered from the handler.
+ * successfully done the given task is unregistered from the handler. This
+ * might look a bit overloaded here but the announcement phase isn't a
+ * simple "Hello there" message, it may later on also contain more
+ * informations like the object list.
*
* @param $taskInstance The task instance running this announcement
* @return void
} // END - if
// Debug output
- $this->debugOutput('HUB: Self-announcement: START (taskInstance=' . $taskInstance->__toString(). ')');
+ $this->debugOutput('HUB: Announcement: START (taskInstance=' . $taskInstance->__toString(). ')');
// Get a helper instance
$helperInstance = ObjectFactory::createObjectByConfiguredName('hub_announcement_helper_class', array($this));
// Load the announcement descriptor
- $helperInstance->loadAnnouncementDescriptor();
+ $helperInstance->loadDescriptorXml();
// Set some dummy configuration entries, e.g. node_status
$this->getConfigInstance()->setConfigEntry('node_status', $this->getStateInstance()->getStateName());
$helperInstance->getTemplateInstance()->compileConfigInVariables();
// "Publish" the descriptor by sending it to the bootstrap/list nodes
- $helperInstance->publishAnnouncementDescriptor();
+ $helperInstance->sendPackage();
// Change the state, this should be the last line except debug output
$this->getStateInstance()->nodeAnnouncedToUpperHubs();
// Debug output
- $this->debugOutput('HUB: Self-announcement: FINISHED');
+ $this->debugOutput('HUB: Announcement: FINISHED');
+ }
+
+ /**
+ * Does a self-connect attempt on the public IP address. This should make
+ * it sure, we are reachable from outside world. For this kind of package we
+ * don't need that overload we have in the announcement phase.
+ *
+ * @param $taskInstance The task instance running this announcement
+ * @return void
+ */
+ public function doSelfConnection (Taskable $taskInstance) {
+ // Debug output
+ $this->debugOutput('HUB: Self Connection: START (taskInstance=' . $taskInstance->__toString(). ')');
+
+ // Get a helper instance
+ $helperInstance = ObjectFactory::createObjectByConfiguredName('hub_self_connect_helper_class', array($this));
+
+ // Load the descriptor (XML) file
+ $helperInstance->loadDescriptorXml();
+
+ // And send the package away
+ $helperInstance->sendPackage();
+
+ // Debug output
+ $this->debugOutput('HUB: Self Connection: FINISHED');
}
/**
* @param $responseInstance A Responseable class
* @return void
*/
- public function activateHub (Requestable $requestInstance, Responseable $responseInstance) {
+ public function activateNode (Requestable $requestInstance, Responseable $responseInstance) {
// Checks wether a listener is still active and shuts it down if one
// is still listening.
if (($this->determineIfListenerIsActive()) && ($this->getIsActive())) {
// Setup address and port
$listenerInstance->setListenAddressByConfiguration('node_listen_addr');
- $listenerInstance->setListenPortByConfiguration('node_tcp_listen_port');
+ 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');
+ }
// Initialize the listener
$listenerInstance->initListener();
// Setup address and port
$listenerInstance->setListenAddressByConfiguration('node_listen_addr');
- $listenerInstance->setListenPortByConfiguration('node_udp_listen_port');
+ 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');
+ }
// Initialize the listener
$listenerInstance->initListener();
public final function enableIsActive ($isActive = true) {
$this->isActive = (bool) $isActive;
}
+
+ /**
+ * "Getter for address:port combination
+ *
+ * @param $handlerInstance A valid Networkable instance
+ * @return $addressPort A address:port combination for this node
+ */
+ public final function getAddressPort (Networkable $handlerInstance) {
+ // Construct config entry
+ $configEntry = 'node_' . $handlerInstance->getHandlerName() . '_listen_port';
+
+ // Get IP and port
+ $addressPort = $this->getConfigInstance()->detectServerAddress() . ':' . $this->getConfigInstance()->getConfigEntry($configEntry);
+
+ // Return it
+ return $addressPort;
+ }
}
// [EOF]