application/hub/classes/handler/message-types/class_

   1 <?php
   2 /**
   3  * A NodeMessage??? handler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.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.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 NodeMessage???Handler 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_===');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         Xml???TemplateEngine::!!!_DATA_EXTERNAL_ADDRESS,
  40                         Xml???TemplateEngine::!!!_DATA_NODE_STATUS,
  41                         Xml???TemplateEngine::!!!_DATA_SESSION_ID,
  42                         Xml???TemplateEngine::!!!_DATA_LISTEN_PORT,
  43                 );
  44         }
  45
  46         /**
  47          * Creates an instance of this class
  48          *
  49          * @return      $handlerInstance        An instance of a HandleableMessage class
  50          */
  51         public final static function createNodeMessage???Handler () {
  52                 // Get new instance
  53                 $handlerInstance = new NodeMessage???Handler();
  54
  55                 // Return the prepared instance
  56                 return $handlerInstance;
  57         }
  58
  59         /**
  60          * Handles data array of the message
  61          *
  62          * @param       $messageData            An array with message data to handle
  63          * @param       $packageInstance        An instance of a Receivable class
  64          * @return      void
  65          */
  66         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  67                 // Register the announcing node with this node
  68                 $this->registerNodeByMessageData($messageData);
  69
  70                 // Prepare answer message to be delivered back to the other node
  71                 $this->prepareAnswerMessage($messageData, $packageInstance);
  72         }
  73
  74         /**
  75          * Adds all required elements from given array into data set instance
  76          *
  77          * @param       $dataSetInstance        An instance of a StoreableCriteria class
  78          * @param       $messageData            An array with all message data
  79          * @return      void
  80          */
  81         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
  82                 // Add all ements
  83                 foreach ($this->messageDataElements as $key) {
  84                         // Is it there?
  85                         assert(isset($messageData[$key]));
  86
  87                         // Add it
  88                         $dataSetInstance->addCriteria($key, $messageData[$key]);
  89                 } // END - foreach
  90         }
  91
  92         /**
  93          * Initializes configuration data from given message data array
  94          *
  95          * @param       $messageData    An array with all message data
  96          * @return      void
  97          */
  98         protected function initMessageConfigurationData (array $messageData) {
  99                 $this->partialStub('Please implement this method.');
 100         }
 101
 102         /**
 103          * Removes configuration data with given message data array from global
 104          * configuration
 105          *
 106          * @param       $messageData    An array with all message data
 107          * @return      void
 108          */
 109         protected function removeMessageConfigurationData (array $messageData) {
 110                 $this->partialStub('Please implement this method.');
 111         }
 112 }
 113
 114 // [EOF]
 115 ?>