3 * A NodeMessageAnnouncementAnswer handler
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 NodeMessageAnnouncementAnswerHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setHandlerName('message_announcement_answer');
37 // Init message data array
38 $this->messageDataElements = array(
39 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
40 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_IP,
41 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS,
42 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
43 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT,
44 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT
47 // Init message-data->configuration translation array
48 $this->messageToConfig = array(
50 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP => 'your_external_ip',
51 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_IP => 'your_internal_ip',
52 XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID => 'your_session_id'
56 // Init config-copy array
57 $this->configCopy = array(
58 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP => 'external_ip',
59 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_IP => 'internal_ip',
60 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS => 'node_status',
61 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID => 'session_id',
62 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT => 'node_tcp_listen_port',
63 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT => 'node_udp_listen_port'
67 $this->searchData = array(
68 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
69 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
70 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT
75 * Creates an instance of this class
77 * @return $handlerInstance An instance of a HandleableMessage class
79 public final static function createNodeMessageAnnouncementAnswerHandler () {
81 $handlerInstance = new NodeMessageAnnouncementAnswerHandler();
83 // Return the prepared instance
84 return $handlerInstance;
88 * Handles data array of the message
90 * @param $messageData An array with message data to handle
91 * @param $packageInstance An instance of a Receivable class
93 * @throws NoAnnouncementAttemptedException If this node has not attempted to announce itself
95 public function handleMessageData (array $messageData, Receivable $packageInstance) {
97 $nodeInstance = Registry::getRegistry()->getInstance('node');
99 // Has this node attempted to announce itself?
100 if (!$nodeInstance->ifNodeHasAnnounced()) {
102 * This node has never announced itself, so it doesn't expect
103 * announcement answer messages.
105 throw new NoAnnouncementAttemptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED);
108 // Register the announcing node with this node
109 $this->registerNodeByMessageData($messageData);
111 // Handle the answer status element
112 $nodeInstance->handleAnswerStatusByMessageData($messageData);
116 * Adds all required elements from given array into data set instance
118 * @param $dataSetInstance An instance of a StoreableCriteria class
119 * @param $messageData An array with all message data
122 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
124 foreach ($this->messageDataElements as $key) {
126 assert(isset($messageData[$key]));
129 $dataSetInstance->addCriteria('node_' . $key, $messageData[$key]);
134 * Initializes configuration data from given message data array
136 * @param $messageData An array with all message data
138 * @throws UnsupportedOperationException If this method is called
140 protected function initMessageConfigurationData (array $messageData) {
141 // Please don't call this method
142 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
146 * Removes configuration data with given message data array from global
149 * @param $messageData An array with all message data
151 * @throws UnsupportedOperationException If this method is called
153 protected function removeMessageConfigurationData (array $messageData) {
154 // Please don't call this method
155 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);