application/hub/templates/xml/object_registry/object_registry.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!--
   3 The object registry. All known (shareable!) object types/names are "registered"
   4 here.
   5
   6 @author         Roland Haeder <webmaster@ship-simu.org>
   7 @version        0.0.0
   8 @copyright      Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
   9 @license        GNU GPL 3.0 or any newer version
  10 @link           http://www.ship-simu.org
  11
  12 This program is free software: you can redistribute it and/or modify
  13 it under the terms of the GNU General Public License as published by
  14 the Free Software Foundation, either version 3 of the License, or
  15 (at your option) any later version.
  16
  17 This program is distributed in the hope that it will be useful,
  18 but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 GNU General Public License for more details.
  21
  22 You should have received a copy of the GNU General Public License
  23 along with this program. If not, see <http://www.gnu.org/licenses/>
  24 //-->
  25 <object-registry>
  26         <!--
  27         A list of object types this hub accepts. Please leave all untouched if
  28         you want to participate in the main network. If you need special objects,
  29         please disconnect from our boot hubs and start your own network.
  30
  31         If you don't do so, you may be banned because of unknown object types your
  32         node tries to advertise/share.
  33         //-->
  34         <object-list object-count="{?object_count?}">
  35                 <!-- A single object type we want to share. //-->
  36                 <object-list-entry>
  37                         <!-- The actual name, this must be the same as tag names are. //-->
  38                         <object-name>announcement</object-name>
  39                         <!--
  40                         Recipient limitation:
  41                         ---------------------
  42                         upper  - Only send to "upper" hubs, these are bootstrap, master and
  43                                  list-nodes
  44                         self   - Only send to itself
  45                         direct - Only direct recipient(s)
  46                         all    - self, upper and direct recipients (currently available)
  47                         ???    - More to follow ...
  48                         //-->
  49                         <object-recipient-limitation>upper</object-recipient-limitation>
  50                         <!--
  51                         Maximum spread of the object. 'self' means only to itself, 1 means,
  52                         only the direct recipient is allowed to keep it (required for
  53                         announcements), 2 means the direct recipient may share it to its
  54                         direct connected hubs. This aids to keep the overall network load at
  55                         low-profile.
  56                         //-->
  57                         <object-max-spread>1</object-max-spread>
  58                         <!--
  59                         The protocol we should use for transmission. Valid is 'unl' without
  60                         the quotes.
  61                         //-->
  62                         <object-protocol>tcp</object-protocol>
  63                         <!--
  64                         The recipient type for this type of object. This can be only one of
  65                         the following:
  66                         --------------------------
  67                         hub  - Only other hubs may receive this object
  68                         peer - Only connected peers (not hubs) may receive this object
  69                         all  - Hubs and peers may receive this object
  70                         //-->
  71                         <object-recipient-type>hub</object-recipient-type>
  72                 </object-list-entry>
  73                 <object-list-entry>
  74                         <object-name>self_connect</object-name>
  75                         <object-recipient-limitation>self</object-recipient-limitation>
  76                         <object-max-spread>self</object-max-spread>
  77                         <object-protocol>unl</object-protocol>
  78                         <object-recipient-type>hub</object-recipient-type>
  79                 </object-list-entry>
  80                 <object-list-entry>
  81                         <object-name>announcement_answer</object-name>
  82                         <object-recipient-limitation>direct</object-recipient-limitation>
  83                         <object-max-spread>1</object-max-spread>
  84                         <object-protocol>unl</object-protocol>
  85                         <object-recipient-type>hub</object-recipient-type>
  86                 </object-list-entry>
  87                 <object-list-entry>
  88                         <object-name>request_node_list</object-name>
  89                         <object-recipient-limitation>upper</object-recipient-limitation>
  90                         <object-max-spread>1</object-max-spread>
  91                         <object-protocol>unl</object-protocol>
  92                         <object-recipient-type>hub</object-recipient-type>
  93                 </object-list-entry>
  94                 <object-list-entry>
  95                         <object-name>request_node_list_answer</object-name>
  96                         <object-recipient-limitation>direct</object-recipient-limitation>
  97                         <object-max-spread>1</object-max-spread>
  98                         <object-protocol>unl</object-protocol>
  99                         <object-recipient-type>hub</object-recipient-type>
 100                 </object-list-entry>
 101                 <object-list-entry>
 102                         <object-name>dht_bootstrap</object-name>
 103                         <object-recipient-limitation>all</object-recipient-limitation>
 104                         <object-max-spread>3</object-max-spread>
 105                         <object-protocol>unl</object-protocol>
 106                         <object-recipient-type>hub</object-recipient-type>
 107                 </object-list-entry>
 108                 <object-list-entry>
 109                         <object-name>dht_bootstrap_answer</object-name>
 110                         <object-recipient-limitation>direct</object-recipient-limitation>
 111                         <object-max-spread>1</object-max-spread>
 112                         <object-protocol>unl</object-protocol>
 113                         <object-recipient-type>hub</object-recipient-type>
 114                 </object-list-entry>
 115                 <object-list-entry>
 116                         <object-name>dht_publish_entry</object-name>
 117                         <object-recipient-limitation>all</object-recipient-limitation>
 118                         <object-max-spread>4</object-max-spread>
 119                         <object-protocol>unl</object-protocol>
 120                         <object-recipient-type>hub</object-recipient-type>
 121                 </object-list-entry>
 122         </object-list>
 123 </object-registry>