[lsd0004] branch master updated: update API

[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 dac2075  update API
dac2075 is described below

commit dac2075e4879a495fe2ec4bb6d5167a28dabfa62
Author: Martin Schanzenbach <schanzen@gnunet.org>
AuthorDate: Wed Dec 29 12:50:43 2021 +0100

    update API
---
 draft-schanzen-r5n.xml | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/draft-schanzen-r5n.xml b/draft-schanzen-r5n.xml
index 1ff1e4a..e1a5cb8 100644
--- a/draft-schanzen-r5n.xml
+++ b/draft-schanzen-r5n.xml
@@ -227,9 +227,7 @@ Connectivity | |Underlay|  |Underlay|
          The GET procedure is defined as follows:
        </t>
          <artwork name="" type="" align="left" alt=""><![CDATA[
-GET(key[, options]) -> RESULTS as List
-           or
-GET(key[, options], callbackFunction)
+GET(Key[, RouteOptions][, XQuery]) -> RESULTS as List
          ]]></artwork>
        <t>
          The procedure takes two arguments. The first argument is the query
@@ -256,8 +254,9 @@ GET(key[, options], callbackFunction)
          </dd>
        </dl>
        <t>
-         The procedure either returns a list of results or allows the caller
-         to provide a callback function which is called for any result
+         As the time it takes for results to arrive may vary an implementation
+         may either return a list of results after a timeout or allow the
+         caller to provide a callback function which is called for any result
          received from the DHT until the procedure is cancelled.
        </t>
      </section>
@@ -267,13 +266,14 @@ GET(key[, options], callbackFunction)
          The PUT procedure is defined as follows:
        </t>
          <artwork name="" type="" align="left" alt=""><![CDATA[
-PUT(key[, options], BLOCK)
+PUT(Key, Block[, RouteOptions])
          ]]></artwork>
        <t>
-         The procedure takes three arguments. The first argument is the query
-         key and is mandatory. The PUT procedure may also allow the caller
-         to specifiy put options. The third argument is the payload data which
-         is to be stored under the provided put key.
+         The procedure takes two mandatory arguments.
+         The first argument is the query
+         key under which the Block is to be stored.
+         The PUT procedure may also allow the caller
+         to specifiy put options.
        </t>
      </section>
    </section>

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