application/hub/templates/xml/dht_publish/publish.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!--
   3 An XML for DHTs publishing their entries
   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 <publish>
  25         <!--
  26         The data in this message is similar to that in announcement, except that an
  27         announcement is sent to boot, master and list nodes but this to "all" nodes
  28         that matches some criteria. If we would send this to *really* all nodes,
  29         this would easily flood the network.
  30
  31         Currently this XML message contains the same data fields as announcement.xml
  32         but this might be changed in the future. And please remember that you can
  33         type as much as you want here, as all will be removed by the compaction
  34         step.
  35
  36         The following example data will be published (except __idx):
  37 Array
  38 (
  39     [node_mode] => regular
  40     [external_address] => tcp://192.168.2.3:9060
  41     [node_id] => 38fc625d3d9aa05654bfc90a7aea7ff72c883f1573
  42     [session_id] => 38fc625d3dabe9ff09b54253b298e91985191472a3
  43     [private_key_hash] => 38fc625d3dad67db034d7e715fae8b8ea47fefb0dc
  44     [accepted_object_types] => announcement,self_connect,announcement_answer,request_node_list,request_node_list_answer,dht_bootstrap
  45     [__idx] => 1
  46 )
  47         //-->
  48         <publish-data>
  49                 <!-- Status of this node, see node_status.xml for details. //-->
  50                 <node-status>{?node_status?}</node-status>
  51                 <!-- Node mode: regular, master, list, boot again //-->
  52                 <node-mode>{?node_default_mode?}</node-mode>
  53                 <!-- The node id. //-->
  54                 <node-id>{?node_id?}</node-id>
  55                 <!-- The session id. This should be announced to all other hubs. //-->
  56                 <session-id>{?session_id?}</session-id>
  57                 <!-- Hash of private key. //-->
  58                 <private-key-hash>{?private_key_hash?}</private-key-hash>
  59                 <!-- Accepted object types //-->
  60                 <accepted-object-types>{?accepted_object_types?}</accepted-object-types>
  61                 <!-- Data from our listeners (e.g. which port) //-->
  62                 <listener>
  63                         <!-- Public external address //-->
  64                         <external-address>{?external_address?}</external-address>
  65                 </listener>
  66         </publish-data>
  67 </publish>