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 - 2011 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>
  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 uploaded to "upper" hubs, these are bootstrap and
  43                                 list-nodes
  44                         self  - Only upload to itself
  45                         ???   - More to follow ...
  46                         //-->
  47                         <object-recipient-limitation>upper</object-recipient-limitation>
  48                         <!--
  49                         Maximum spread of the object. 'self' means only to itself, 1 means,
  50                         only the direct recipient is allowed to keep it (required for
  51                         announcements), 2 means the direct recipient may share it to its
  52                         direct connected hubs. This aids to keep the overall network load at
  53                         low-profile.
  54                         //-->
  55                         <object-max-spread>1</object-max-spread>
  56                         <!--
  57                         The protocol we should use for transmission. Valid values can be
  58                         'tcp' or 'udp', without the quotes.
  59                         //-->
  60                         <object-protocol>tcp</object-protocol>
  61                         <!--
  62                         The recipient type for this type of object. This can be only one of
  63                         the following:
  64                         --------------------------
  65                         hub  - Only other hubs may receive this object
  66                         peer - Only connected peers (not hubs) may receive this object
  67                         all  - Hubs and peers may receive this object
  68                         //-->
  69                         <object-recipient-type>hub</object-recipient-type>
  70                 </object-list-entry>
  71                 <!-- A single object type we want to share. //-->
  72                 <object-list-entry>
  73                         <!-- The actual name, this must be the same as tag names are. //-->
  74                         <object-name>self_connect</object-name>
  75                         <!-- Recipient limitation //-->
  76                         <object-recipient-limitation>self</object-recipient-limitation>
  77                         <!-- Maximum spread of the object //-->
  78                         <object-max-spread>self</object-max-spread>
  79                         <!-- The protocol we should use for transmission //-->
  80                         <object-protocol>tcp</object-protocol>
  81                         <!-- The recipient type for this type of object //-->
  82                         <object-recipient-type>hub</object-recipient-type>
  83                 </object-list-entry>
  84         </object-list>
  85 </object-registry>