summaryrefslogtreecommitdiff
path: root/draft-schanzen-r5n.xml
diff options
context:
space:
mode:
authorMartin Schanzenbach <schanzen@gnunet.org>2021-12-29 12:44:50 +0100
committerMartin Schanzenbach <schanzen@gnunet.org>2021-12-29 12:44:50 +0100
commit9b6f4c2dd2faf637acc225eb17dbe1bb870310bd (patch)
tree9d2f23be9fe05733a8bc25a1dae07f6f0089df69 /draft-schanzen-r5n.xml
parentea6c8d90329ee2cbd609de9f815baabb9f2ea2a5 (diff)
downloadlsd0004-9b6f4c2dd2faf637acc225eb17dbe1bb870310bd.tar.gz
lsd0004-9b6f4c2dd2faf637acc225eb17dbe1bb870310bd.zip
move processing options
Diffstat (limited to 'draft-schanzen-r5n.xml')
-rw-r--r--draft-schanzen-r5n.xml49
1 files changed, 20 insertions, 29 deletions
diff --git a/draft-schanzen-r5n.xml b/draft-schanzen-r5n.xml
index f8c1294..1ff1e4a 100644
--- a/draft-schanzen-r5n.xml
+++ b/draft-schanzen-r5n.xml
@@ -234,8 +234,27 @@ GET(key[, options], callbackFunction)
234 <t> 234 <t>
235 The procedure takes two arguments. The first argument is the query 235 The procedure takes two arguments. The first argument is the query
236 key and is mandatory. The GET procedure may also allow the caller 236 key and is mandatory. The GET procedure may also allow the caller
237 to specifiy query options. 237 to specifiy <tt>RouteOptions</tt> in order to indicate certain
238 processing requirements for messages.
239 Any combination of options may be specificied.
238 </t> 240 </t>
241 <dl>
242 <dt>DemultiplexEverywhere</dt>
243 <dd>
244 indicates that each peer along the way should process the request.
245 </dd>
246 <dt>RecordRoute</dt>
247 <dd>
248 indicates to keep track of the route that the message takes
249 in the P2P network.
250 </dd>
251 <dt>FindPeer</dt>
252 <dd>
253 indicates that this is a request used to find additional peers.
254 This is a special flag which modifies the message processing to
255 allow approximate results.
256 </dd>
257 </dl>
239 <t> 258 <t>
240 The procedure either returns a list of results or allows the caller 259 The procedure either returns a list of results or allows the caller
241 to provide a callback function which is called for any result 260 to provide a callback function which is called for any result
@@ -528,34 +547,6 @@ END
528 547
529 548
530 </section> 549 </section>
531 <section anchor="p2p_opts" numbered="true" toc="default">
532 <name>Processing options</name>
533 <t>
534 In order to indicate certain processing requirements for messages
535 a number of processing options may be specificied in the respective
536 field of the signalling messages.
537 The options field is 8 octets in length and each options is encoded
538 in a single bit.
539 </t>
540 <dl>
541 <dt>Demultiplex everywhere (0)</dt>
542 <dd>
543 Each peer along the way should process the request. Otherwise
544 only peers that are locally closest to the key and no longer in the
545 random path mode should process it.
546 </dd>
547 <dt>Record route (1)</dt>
548 <dd>
549 Indicates to keep track of the route that the message
550 took in the P2P network.
551 </dd>
552 <dt>Find peer (2)</dt>
553 <dd>
554 Indicates a 'FIND-PEER' request. Implies that approximate results are
555 acceptable.
556 </dd>
557 </dl>
558 </section>
559 <section anchor="p2p_xq" numbered="true" toc="default"> 550 <section anchor="p2p_xq" numbered="true" toc="default">
560 <name>Extended query</name> 551 <name>Extended query</name>
561 <t>TODO: What is this for? Not documented anywhere</t> 552 <t>TODO: What is this for? Not documented anywhere</t>