diff options
author | Martin Schanzenbach <schanzen@gnunet.org> | 2021-12-29 12:50:43 +0100 |
---|---|---|
committer | Martin Schanzenbach <schanzen@gnunet.org> | 2021-12-29 12:50:43 +0100 |
commit | dac2075e4879a495fe2ec4bb6d5167a28dabfa62 (patch) | |
tree | e5a2b596d6523fc7bf3f052b5af6f7ed7c414268 /draft-schanzen-r5n.xml | |
parent | 9b6f4c2dd2faf637acc225eb17dbe1bb870310bd (diff) | |
download | lsd0004-dac2075e4879a495fe2ec4bb6d5167a28dabfa62.tar.gz lsd0004-dac2075e4879a495fe2ec4bb6d5167a28dabfa62.zip |
update API
Diffstat (limited to 'draft-schanzen-r5n.xml')
-rw-r--r-- | draft-schanzen-r5n.xml | 20 |
1 files 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| | |||
227 | The GET procedure is defined as follows: | 227 | The GET procedure is defined as follows: |
228 | </t> | 228 | </t> |
229 | <artwork name="" type="" align="left" alt=""><![CDATA[ | 229 | <artwork name="" type="" align="left" alt=""><![CDATA[ |
230 | GET(key[, options]) -> RESULTS as List | 230 | GET(Key[, RouteOptions][, XQuery]) -> RESULTS as List |
231 | or | ||
232 | GET(key[, options], callbackFunction) | ||
233 | ]]></artwork> | 231 | ]]></artwork> |
234 | <t> | 232 | <t> |
235 | The procedure takes two arguments. The first argument is the query | 233 | The procedure takes two arguments. The first argument is the query |
@@ -256,8 +254,9 @@ GET(key[, options], callbackFunction) | |||
256 | </dd> | 254 | </dd> |
257 | </dl> | 255 | </dl> |
258 | <t> | 256 | <t> |
259 | The procedure either returns a list of results or allows the caller | 257 | As the time it takes for results to arrive may vary an implementation |
260 | to provide a callback function which is called for any result | 258 | may either return a list of results after a timeout or allow the |
259 | caller to provide a callback function which is called for any result | ||
261 | received from the DHT until the procedure is cancelled. | 260 | received from the DHT until the procedure is cancelled. |
262 | </t> | 261 | </t> |
263 | </section> | 262 | </section> |
@@ -267,13 +266,14 @@ GET(key[, options], callbackFunction) | |||
267 | The PUT procedure is defined as follows: | 266 | The PUT procedure is defined as follows: |
268 | </t> | 267 | </t> |
269 | <artwork name="" type="" align="left" alt=""><![CDATA[ | 268 | <artwork name="" type="" align="left" alt=""><![CDATA[ |
270 | PUT(key[, options], BLOCK) | 269 | PUT(Key, Block[, RouteOptions]) |
271 | ]]></artwork> | 270 | ]]></artwork> |
272 | <t> | 271 | <t> |
273 | The procedure takes three arguments. The first argument is the query | 272 | The procedure takes two mandatory arguments. |
274 | key and is mandatory. The PUT procedure may also allow the caller | 273 | The first argument is the query |
275 | to specifiy put options. The third argument is the payload data which | 274 | key under which the Block is to be stored. |
276 | is to be stored under the provided put key. | 275 | The PUT procedure may also allow the caller |
276 | to specifiy put options. | ||
277 | </t> | 277 | </t> |
278 | </section> | 278 | </section> |
279 | </section> | 279 | </section> |