[lsd0004] branch master updated: add descriptions for messages

[gnunet]

This is an automated email from the git hooks/post-receive script.

martin-schanzenbach pushed a commit to branch master
in repository lsd0004.

The following commit(s) were added to refs/heads/master by this push:
     new b14f7e0  add descriptions for messages
b14f7e0 is described below

commit b14f7e0d774a5074ac6fe344c38a221abc843ead
Author: Martin Schanzenbach <mschanzenbach@posteo.de>
AuthorDate: Sun May 23 12:17:14 2021 +0200

    add descriptions for messages
---
 draft-schanzen-r5n.xml | 184 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 182 insertions(+), 2 deletions(-)

diff --git a/draft-schanzen-r5n.xml b/draft-schanzen-r5n.xml
index d6e03ac..f4cffaa 100644
--- a/draft-schanzen-r5n.xml
+++ b/draft-schanzen-r5n.xml
@@ -136,6 +136,70 @@
 +-----+-----+-----+-----+-----+-----+-----+-----+
          ]]></artwork>
      </figure>
+     <t>where:</t>
+     <dl>
+       <dt>MSIZE</dt>
+       <dd>
+         denotes the size of this message in network byte order.
+       </dd>
+       <dt>MTYPE</dt>
+       <dd>
+         is the 16-bit message type. This type can be one of the DHT message
+         types but for put messages it must be set to
+         the value 146 in network byte order.
+       </dd>
+       <dt>OPTIONS</dt>
+       <dd>
+         is a 32-bit options field (see below).
+       </dd>
+       <dt>BTYPE</dt>
+       <dd>
+         is a 32-bit block type field. The block type indicates the content
+         type of the payload. In network byte order.
+       </dd>
+       <dt>HOPCOUNT</dt>
+       <dd>
+         is a 32-bit number indicating how many hops this message has
+         traversed to far. In network byte order.
+       </dd>
+       <dt>REPLICATIONLVL</dt>
+       <dd>
+         is a 32-bit number indicating the desired replication level of
+         the data. In network byte order.
+       </dd>
+       <dt>PATH_LEN</dt>
+       <dd>
+         is a 32-bit number indicating the length of the PUT path recorded
+         in PUTPATH. As PUTPATH is optiona, this value may be zero.
+         In network byte order.
+       </dd>
+       <dt>EXPIRATION</dt>
+       <dd>
+         denotes the absolute 64-bit expiration date of the content.
+         In microseconds since midnight (0 hour), January 1, 1970 in network
+         byte order.
+       </dd>
+       <dt>BLOOMFILTER</dt>
+       <dd>
+         A bloomfilter (for peer identities) to stop circular routes.
+       </dd>
+       <dt>KEY</dt>
+       <dd>
+         The key under which the PUT request wants to store content
+         under.
+       </dd>
+       <dt>PUTPATH</dt>
+       <dd>
+         the variable-length PUT path.
+         The path consists of a list of PATH_LEN peer IDs.
+       </dd>
+       <dt>PAYLOAD</dt>
+       <dd>
+         the variable-length resource record data payload. The contents are 
defined
+         by the
+         respective type of the resource record.
+       </dd>
+     </dl>
 
      </section>
      <section anchor="p2p_get" numbered="true" toc="default">
@@ -166,6 +230,64 @@
 +-----+-----+-----+-----+-----+-----+-----+-----+
          ]]></artwork>
      </figure>
+     <t>where:</t>
+     <dl>
+       <dt>MSIZE</dt>
+       <dd>
+         denotes the size of this message in network byte order.
+       </dd>
+       <dt>MTYPE</dt>
+       <dd>
+         is the 16-bit message type. This type can be one of the DHT message
+         types but for put messages it must be set to
+         the value 146 in network byte order.
+       </dd>
+       <dt>OPTIONS</dt>
+       <dd>
+         is a 32-bit options field (see below).
+       </dd>
+       <dt>BTYPE</dt>
+       <dd>
+         is a 32-bit block type field. The block type indicates the content
+         type of the payload. In network byte order.
+       </dd>
+       <dt>HOPCOUNT</dt>
+       <dd>
+         is a 32-bit number indicating how many hops this message has
+         traversed to far. In network byte order.
+       </dd>
+       <dt>REPLICATIONLVL</dt>
+       <dd>
+         is a 32-bit number indicating the desired replication level of
+         the data. In network byte order.
+       </dd>
+       <dt>XQUERY_SIZE</dt>
+       <dd>
+         is a 32-bit number indicating the length of the optional
+         extended query XQUERY. In network byte order.
+       </dd>
+       <dt>BF_MUTATOR</dt>
+       <dd>
+         The bloomfilter mutator.
+       </dd>
+       <dt>BLOOMFILTER</dt>
+       <dd>
+         A bloomfilter (for peer identities) to stop circular routes.
+       </dd>
+       <dt>KEY</dt>
+       <dd>
+         The key under which the PUT request wants to store content
+         under.
+       </dd>
+       <dt>XQUERY</dt>
+       <dd>
+         the variable-length extended query. Optional.
+       </dd>
+       <dt>BF_RESULT</dt>
+       <dd>
+         the variable-length result bloomfilter.
+       </dd>
+     </dl>
      </section>
      <section anchor="p2p_result" numbered="true" toc="default">
        <name>RESULT message</name>
@@ -193,8 +315,66 @@
 +-----+-----+-----+-----+-----+-----+-----+-----+
          ]]></artwork>
      </figure>
-
-
+     <t>where:</t>
+     <dl>
+       <dt>MSIZE</dt>
+       <dd>
+         denotes the size of this message in network byte order.
+       </dd>
+       <dt>MTYPE</dt>
+       <dd>
+         is the 16-bit message type. This type can be one of the DHT message
+         types but for put messages it must be set to
+         the value 146 in network byte order.
+       </dd>
+       <dt>OPTIONS</dt>
+       <dd>
+         is a 32-bit options field (see below).
+       </dd>
+       <dt>BTYPE</dt>
+       <dd>
+         is a 32-bit block type field. The block type indicates the content
+         type of the payload. In network byte order.
+       </dd>
+       <dt>PUT_PATH_LEN</dt>
+       <dd>
+         is a 32-bit number indicating the length of the PUT path recorded
+         in PUTPATH. As PUTPATH is optiona, this value may be zero.
+         In network byte order.
+       </dd>
+       <dt>GET_PATH_LEN</dt>
+       <dd>
+         is a 32-bit number indicating the length of the GET path recorded
+         in GETPATH. As PUTPATH is optiona, this value may be zero.
+         In network byte order.
+       </dd>
+       <dt>EXPIRATION</dt>
+       <dd>
+         denotes the absolute 64-bit expiration date of the content.
+         In microseconds since midnight (0 hour), January 1, 1970 in network
+         byte order.
+       </dd>
+       <dt>KEY</dt>
+       <dd>
+         The key under which the PUT request wants to store content
+         under.
+       </dd>
+       <dt>PUTPATH</dt>
+       <dd>
+         the variable-length PUT path.
+         The path consists of a list of PATH_LEN peer IDs.
+       </dd>
+       <dt>GETPATH</dt>
+       <dd>
+         the variable-length PUT path.
+         The path consists of a list of PATH_LEN peer IDs.
+       </dd>
+       <dt>PAYLOAD</dt>
+       <dd>
+         the variable-length resource record data payload.
+         The contents are defined by the respective type of the resource 
record.
+       </dd>
+     </dl>
      </section>
    </section>
    <section anchor="security" numbered="true" toc="default">

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.