application/hub/main/handler/message-types/anouncement/class_NodeMessageAnnouncementHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageAnnouncement handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  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 NodeMessageAnnouncementHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set handler name
  35                 $this->setHandlerName('message_type_announcement');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP,
  40                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS,
  41                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID,
  42                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT,
  43                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT
  44                 );
  45         }
  46
  47         /**
  48          * Creates an instance of this class
  49          *
  50          * @return      $handlerInstance        An instance of a HandleableMessage class
  51          */
  52         public final static function createNodeMessageAnnouncementHandler () {
  53                 // Get new instance
  54                 $handlerInstance = new NodeMessageAnnouncementHandler();
  55
  56                 // Return the prepared instance
  57                 return $handlerInstance;
  58         }
  59
  60         /**
  61          * Handles data array of the message
  62          *
  63          * @param       $messageData            An array with message data to handle
  64          * @param       $packageInstance        An instance of a Receivable class
  65          * @return      void
  66          */
  67         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  68                 // Register the announcing node with this node
  69                 $this->registerNodeByMessageData($messageData);
  70
  71                 // Prepare answer message to be delivered back to the other node
  72                 $this->prepareAnswerMessage($messageData, $packageInstance);
  73         }
  74
  75         /**
  76          * Adds all required elements from given array into data set instance
  77          *
  78          * @param       $dataSetInstance        An instance of a StoreableCriteria class
  79          * @param       $messageData            An array with all message data
  80          * @return      void
  81          */
  82         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
  83                 // Add all ements
  84                 foreach ($this->messageDataElements as $key) {
  85                         // Is it there?
  86                         assert(isset($messageData[$key]));
  87
  88                         // Add it
  89                         $dataSetInstance->addCriteria('node_' . $key, $messageData[$key]);
  90                 } // END - foreach
  91         }
  92 }
  93
  94 // [EOF]
  95 ?>