Clarify coap_add_data_blocked_response() usage

include/coap2/block.h
man/coap_pdu_setup.txt.in

Update documentation on coap_add_data_blocked_response() usage.
This commit is contained in:
Jon Shallow committed 2019-01-11 16:39:02 +00:00
1 parent 5a8c59e5aa
commit 164eef538b
2 files changed
+13 -6

No files matched your search

+5 -4
View File
@@ -139,9 +139,10 @@ int coap_add_block(coap_pdu_t *pdu,
unsigned char block_szx);
/**
* Adds the @p data to the @p response pdu. If blocks are
* required, then the appropriate block will be added and
* consequently sent.
* Adds the appropriate part of @p data to the @p response pdu. If blocks are
* required, then the appropriate block will be added to the PDU and sent.
* Adds a ETAG option that is the hash of the entire data if the data is to be
* split into blocks
* Used by a GET request handler.
*
* @param resource The resource the data is associated with.
@@ -153,7 +154,7 @@ int coap_add_block(coap_pdu_t *pdu,
* @param maxage The maxmimum life of the data. If @c -1, then there
* is no maxage.
* @param length The total length of the data.
* @param data The data to transmit.
* @param data The entire data block to transmit.
*
*/
void