A lot changes for refacturing protocol handler

[hub.git] / application / hub / templates / xml / object_registry / object_registry.xml

diff --git a/application/hub/templates/xml/object_registry/object_registry.xml b/application/hub/templates/xml/object_registry/object_registry.xml
index 6c0b7d9d9d185dd3fe8c19b32d0355198cfcb39a..cb8966b5ba1503036f530061df604e62befbf759 100644 (file)
--- a/application/hub/templates/xml/object_registry/object_registry.xml
+++ b/application/hub/templates/xml/object_registry/object_registry.xml
@@ -5,7 +5,7 @@ here.
 
 @author                Roland Haeder <webmaster@ship-simu.org>
 @version       0.0.0
-@copyright     Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
+@copyright     Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
 @license       GNU GPL 3.0 or any newer version
 @link          http://www.ship-simu.org
 
@@ -31,7 +31,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>
        If you don't do so, you may be banned because of unknown object types your
        node tries to advertise/share.
        //-->
-       <object-list>
+       <object-list object-count="{?object_count?}">
                <!-- A single object type we want to share. //-->
                <object-list-entry>
                        <!-- The actual name, this must be the same as tag names are. //-->
@@ -39,23 +39,85 @@ along with this program. If not, see <http://www.gnu.org/licenses/>
                        <!--
                        Recipient limitation:
                        ---------------------
-                       upper - Only uploaded to "upper" hubs, these are bootstrap and
-                               list-nodes
-                       ???   - More to follow ...
+                       upper  - Only send to "upper" hubs, these are bootstrap, master and
+                                list-nodes
+                       self   - Only send to itself
+                       direct - Only direct recipient(s)
+                       all    - self, upper and direct recipients (currently available)
+                       ???    - More to follow ...
                        //-->
                        <object-recipient-limitation>upper</object-recipient-limitation>
                        <!--
-                       Maximum spread of the object. 1 means, only the direct recipient is
-                       allowed to keep it (required for announcements), 2 means the direct
-                       recipient may share it to its direct connected hubs. This aids to
-                       keep the overall network load at low-profile.
+                       Maximum spread of the object. 'self' means only to itself, 1 means,
+                       only the direct recipient is allowed to keep it (required for
+                       announcements), 2 means the direct recipient may share it to its
+                       direct connected hubs. This aids to keep the overall network load at
+                       low-profile.
                        //-->
                        <object-max-spread>1</object-max-spread>
                        <!--
-                       The protocol we should use for transmission. Valid values can be
-                       'tcp' or 'udp', without the quotes.
+                       The protocol we should use for transmission. Valid is 'unl' without
+                       the quotes.
                        //-->
                        <object-protocol>tcp</object-protocol>
+                       <!--
+                       The recipient type for this type of object. This can be only one of
+                       the following:
+                       --------------------------
+                       hub  - Only other hubs may receive this object
+                       peer - Only connected peers (not hubs) may receive this object
+                       all  - Hubs and peers may receive this object
+                       //-->
+                       <object-recipient-type>hub</object-recipient-type>
+               </object-list-entry>
+               <object-list-entry>
+                       <object-name>self_connect</object-name>
+                       <object-recipient-limitation>self</object-recipient-limitation>
+                       <object-max-spread>self</object-max-spread>
+                       <object-protocol>unl</object-protocol>
+                       <object-recipient-type>hub</object-recipient-type>
+               </object-list-entry>
+               <object-list-entry>
+                       <object-name>announcement_answer</object-name>
+                       <object-recipient-limitation>direct</object-recipient-limitation>
+                       <object-max-spread>1</object-max-spread>
+                       <object-protocol>unl</object-protocol>
+                       <object-recipient-type>hub</object-recipient-type>
+               </object-list-entry>
+               <object-list-entry>
+                       <object-name>request_node_list</object-name>
+                       <object-recipient-limitation>upper</object-recipient-limitation>
+                       <object-max-spread>1</object-max-spread>
+                       <object-protocol>unl</object-protocol>
+                       <object-recipient-type>hub</object-recipient-type>
+               </object-list-entry>
+               <object-list-entry>
+                       <object-name>request_node_list_answer</object-name>
+                       <object-recipient-limitation>direct</object-recipient-limitation>
+                       <object-max-spread>1</object-max-spread>
+                       <object-protocol>unl</object-protocol>
+                       <object-recipient-type>hub</object-recipient-type>
+               </object-list-entry>
+               <object-list-entry>
+                       <object-name>dht_bootstrap</object-name>
+                       <object-recipient-limitation>all</object-recipient-limitation>
+                       <object-max-spread>3</object-max-spread>
+                       <object-protocol>unl</object-protocol>
+                       <object-recipient-type>hub</object-recipient-type>
+               </object-list-entry>
+               <object-list-entry>
+                       <object-name>dht_bootstrap_answer</object-name>
+                       <object-recipient-limitation>direct</object-recipient-limitation>
+                       <object-max-spread>1</object-max-spread>
+                       <object-protocol>unl</object-protocol>
+                       <object-recipient-type>hub</object-recipient-type>
+               </object-list-entry>
+               <object-list-entry>
+                       <object-name>dht_publish_entry</object-name>
+                       <object-recipient-limitation>all</object-recipient-limitation>
+                       <object-max-spread>4</object-max-spread>
+                       <object-protocol>unl</object-protocol>
+                       <object-recipient-type>hub</object-recipient-type>
                </object-list-entry>
        </object-list>
 </object-registry>