Mirror/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-07-25 17:18:12 -07:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Mark Qvist
2026-07-24 20:44:55 +02:00
parent e5d37355b8
commit 0d16e2305e
24 changed files with 112 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/markdown/reference.md
+12 -1
View File
@@ -474,6 +474,16 @@ Sets the destinations proof strategy.
* **Parameters:**
**proof_strategy** – One of `RNS.Destination.PROVE_NONE`, `RNS.Destination.PROVE_ALL` or `RNS.Destination.PROVE_APP`. If `RNS.Destination.PROVE_APP` is set, the proof_requested_callback will be called to determine whether a proof should be sent or not.
#### `set_max_request_size(max_request_size)`
Sets the maximum accepted request size for registered request handlers.
* **Parameters:**
**max_request_size** – The maximum accepted request size in bytes, as an integer.
* **Raises:**
`TypeError` or `ValueError` if any of the argument is invalid.
#### `register_request_handler(path, response_generator=None, allow=ALLOW_NONE, allowed_list=None, auto_compress=True)`
Registers a request handler.
@@ -757,7 +767,7 @@ thus preserved. This method can be used for authentication.
* **Parameters:**
**identity** – An RNS.Identity instance to identify as.
#### `request(path, data=None, response_callback=None, failed_callback=None, progress_callback=None, timeout=None)`
#### `request(path, data=None, response_callback=None, failed_callback=None, progress_callback=None, timeout=None, max_response_size=None)`
Sends a request to the remote peer.
@@ -766,6 +776,7 @@ Sends a request to the remote peer.
* **response_callback** – An optional function or method with the signature *response_callback(request_receipt)* to be called when a response is received. See the [Request Example](examples.md#example-request) for more info.
* **failed_callback** – An optional function or method with the signature *failed_callback(request_receipt)* to be called when a request fails. See the [Request Example](examples.md#example-request) for more info.
* **progress_callback** – An optional function or method with the signature *progress_callback(request_receipt)* to be called when progress is made receiving the response. Progress can be accessed as a float between 0.0 and 1.0 by the *request_receipt.progress* property.
* **max_response_size** – An optional maximum accepted response size, in bytes as an integer.
* **timeout** – An optional timeout in seconds for the request. If *None* is supplied it will be calculated based on link RTT.
* **Returns:**