add descriptions for messages

author: Martin Schanzenbach <mschanzenbach@posteo.de> 2021-05-23 12:17:14 +0200
committer: Martin Schanzenbach <mschanzenbach@posteo.de> 2021-05-23 12:17:14 +0200
commit: b14f7e0d774a5074ac6fe344c38a221abc843ead (patch)
tree: 4c3e7e13326f1956ecbaff19685fca79daa1506d
parent: c89000e032f93b5bab87d122f35427796953d274 (diff)
download: lsd0004-b14f7e0d774a5074ac6fe344c38a221abc843ead.tar.gz
lsd0004-b14f7e0d774a5074ac6fe344c38a221abc843ead.zip
1 files 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">
author	Martin Schanzenbach <mschanzenbach@posteo.de>	2021-05-23 12:17:14 +0200
committer	Martin Schanzenbach <mschanzenbach@posteo.de>	2021-05-23 12:17:14 +0200
commit	b14f7e0d774a5074ac6fe344c38a221abc843ead (patch)
tree	4c3e7e13326f1956ecbaff19685fca79daa1506d
parent	c89000e032f93b5bab87d122f35427796953d274 (diff)
download	lsd0004-b14f7e0d774a5074ac6fe344c38a221abc843ead.tar.gz lsd0004-b14f7e0d774a5074ac6fe344c38a221abc843ead.zip

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 @@
136	+-----+-----+-----+-----+-----+-----+-----+-----+	136	+-----+-----+-----+-----+-----+-----+-----+-----+
137	]]></artwork>	137	]]></artwork>
138	</figure>	138	</figure>
		139	<t>where:</t>
		140	<dl>
		141	<dt>MSIZE</dt>
		142	<dd>
		143	denotes the size of this message in network byte order.
		144	</dd>
		145	<dt>MTYPE</dt>
		146	<dd>
		147	is the 16-bit message type. This type can be one of the DHT message
		148	types but for put messages it must be set to
		149	the value 146 in network byte order.
		150	</dd>
		151	<dt>OPTIONS</dt>
		152	<dd>
		153	is a 32-bit options field (see below).
		154	</dd>
		155	<dt>BTYPE</dt>
		156	<dd>
		157	is a 32-bit block type field. The block type indicates the content
		158	type of the payload. In network byte order.
		159	</dd>
		160	<dt>HOPCOUNT</dt>
		161	<dd>
		162	is a 32-bit number indicating how many hops this message has
		163	traversed to far. In network byte order.
		164	</dd>
		165	<dt>REPLICATIONLVL</dt>
		166	<dd>
		167	is a 32-bit number indicating the desired replication level of
		168	the data. In network byte order.
		169	</dd>
		170	<dt>PATH_LEN</dt>
		171	<dd>
		172	is a 32-bit number indicating the length of the PUT path recorded
		173	in PUTPATH. As PUTPATH is optiona, this value may be zero.
		174	In network byte order.
		175	</dd>
		176	<dt>EXPIRATION</dt>
		177	<dd>
		178	denotes the absolute 64-bit expiration date of the content.
		179	In microseconds since midnight (0 hour), January 1, 1970 in network
		180	byte order.
		181	</dd>
		182	<dt>BLOOMFILTER</dt>
		183	<dd>
		184	A bloomfilter (for peer identities) to stop circular routes.
		185	</dd>
		186	<dt>KEY</dt>
		187	<dd>
		188	The key under which the PUT request wants to store content
		189	under.
		190	</dd>
		191	<dt>PUTPATH</dt>
		192	<dd>
		193	the variable-length PUT path.
		194	The path consists of a list of PATH_LEN peer IDs.
		195	</dd>
		196	<dt>PAYLOAD</dt>
		197	<dd>
		198	the variable-length resource record data payload. The contents are defined
		199	by the
		200	respective type of the resource record.
		201	</dd>
		202	</dl>
139		203
140	</section>	204	</section>
141	<section anchor="p2p_get" numbered="true" toc="default">	205	<section anchor="p2p_get" numbered="true" toc="default">
@@ -166,6 +230,64 @@
166	+-----+-----+-----+-----+-----+-----+-----+-----+	230	+-----+-----+-----+-----+-----+-----+-----+-----+
167	]]></artwork>	231	]]></artwork>
168	</figure>	232	</figure>
		233	<t>where:</t>
		234	<dl>
		235	<dt>MSIZE</dt>
		236	<dd>
		237	denotes the size of this message in network byte order.
		238	</dd>
		239	<dt>MTYPE</dt>
		240	<dd>
		241	is the 16-bit message type. This type can be one of the DHT message
		242	types but for put messages it must be set to
		243	the value 146 in network byte order.
		244	</dd>
		245	<dt>OPTIONS</dt>
		246	<dd>
		247	is a 32-bit options field (see below).
		248	</dd>
		249	<dt>BTYPE</dt>
		250	<dd>
		251	is a 32-bit block type field. The block type indicates the content
		252	type of the payload. In network byte order.
		253	</dd>
		254	<dt>HOPCOUNT</dt>
		255	<dd>
		256	is a 32-bit number indicating how many hops this message has
		257	traversed to far. In network byte order.
		258	</dd>
		259	<dt>REPLICATIONLVL</dt>
		260	<dd>
		261	is a 32-bit number indicating the desired replication level of
		262	the data. In network byte order.
		263	</dd>
		264	<dt>XQUERY_SIZE</dt>
		265	<dd>
		266	is a 32-bit number indicating the length of the optional
		267	extended query XQUERY. In network byte order.
		268	</dd>
		269	<dt>BF_MUTATOR</dt>
		270	<dd>
		271	The bloomfilter mutator.
		272	</dd>
		273	<dt>BLOOMFILTER</dt>
		274	<dd>
		275	A bloomfilter (for peer identities) to stop circular routes.
		276	</dd>
		277	<dt>KEY</dt>
		278	<dd>
		279	The key under which the PUT request wants to store content
		280	under.
		281	</dd>
		282	<dt>XQUERY</dt>
		283	<dd>
		284	the variable-length extended query. Optional.
		285	</dd>
		286	<dt>BF_RESULT</dt>
		287	<dd>
		288	the variable-length result bloomfilter.
		289	</dd>
		290	</dl>
169	</section>	291	</section>
170	<section anchor="p2p_result" numbered="true" toc="default">	292	<section anchor="p2p_result" numbered="true" toc="default">
171	<name>RESULT message</name>	293	<name>RESULT message</name>
@@ -193,8 +315,66 @@
193	+-----+-----+-----+-----+-----+-----+-----+-----+	315	+-----+-----+-----+-----+-----+-----+-----+-----+
194	]]></artwork>	316	]]></artwork>
195	</figure>	317	</figure>
196		318	<t>where:</t>
197		319	<dl>
		320	<dt>MSIZE</dt>
		321	<dd>
		322	denotes the size of this message in network byte order.
		323	</dd>
		324	<dt>MTYPE</dt>
		325	<dd>
		326	is the 16-bit message type. This type can be one of the DHT message
		327	types but for put messages it must be set to
		328	the value 146 in network byte order.
		329	</dd>
		330	<dt>OPTIONS</dt>
		331	<dd>
		332	is a 32-bit options field (see below).
		333	</dd>
		334	<dt>BTYPE</dt>
		335	<dd>
		336	is a 32-bit block type field. The block type indicates the content
		337	type of the payload. In network byte order.
		338	</dd>
		339	<dt>PUT_PATH_LEN</dt>
		340	<dd>
		341	is a 32-bit number indicating the length of the PUT path recorded
		342	in PUTPATH. As PUTPATH is optiona, this value may be zero.
		343	In network byte order.
		344	</dd>
		345	<dt>GET_PATH_LEN</dt>
		346	<dd>
		347	is a 32-bit number indicating the length of the GET path recorded
		348	in GETPATH. As PUTPATH is optiona, this value may be zero.
		349	In network byte order.
		350	</dd>
		351	<dt>EXPIRATION</dt>
		352	<dd>
		353	denotes the absolute 64-bit expiration date of the content.
		354	In microseconds since midnight (0 hour), January 1, 1970 in network
		355	byte order.
		356	</dd>
		357	<dt>KEY</dt>
		358	<dd>
		359	The key under which the PUT request wants to store content
		360	under.
		361	</dd>
		362	<dt>PUTPATH</dt>
		363	<dd>
		364	the variable-length PUT path.
		365	The path consists of a list of PATH_LEN peer IDs.
		366	</dd>
		367	<dt>GETPATH</dt>
		368	<dd>
		369	the variable-length PUT path.
		370	The path consists of a list of PATH_LEN peer IDs.
		371	</dd>
		372	<dt>PAYLOAD</dt>
		373	<dd>
		374	the variable-length resource record data payload.
		375	The contents are defined by the respective type of the resource record.
		376	</dd>
		377	</dl>
198	</section>	378	</section>
199	</section>	379	</section>
200	<section anchor="security" numbered="true" toc="default">	380	<section anchor="security" numbered="true" toc="default">