mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-16 21:14:55 +03:00
coap_pdu_setup.txt.in: Better document coap_encode_var_safe8()
Document return value can be 0 for both being valid and returning on error. Same is true for coap_encode_var_safe(). [Error should assert() by default]
This commit is contained in:
1 parent
2a329e1c76
commit
a8c00f2af9
2 files changed
+8
-6
No files matched your search
@@ -78,7 +78,8 @@ uint64_t coap_decode_var_bytes8(const uint8_t *buf, size_t length);
|
||||
* @param length The output buffer size to encode into (must be sufficient)
|
||||
* @param value The value to encode into the buffer
|
||||
*
|
||||
* @return The number of bytes used to encode @p value or @c 0 on error.
|
||||
* @return The number of bytes used to encode @p value (which can be 0
|
||||
* when encoding value of 0) or @c 0 on error.
|
||||
*/
|
||||
unsigned int coap_encode_var_safe(uint8_t *buf,
|
||||
size_t length,
|
||||
@@ -94,7 +95,8 @@ unsigned int coap_encode_var_safe(uint8_t *buf,
|
||||
* @param length The output buffer size to encode into (must be sufficient)
|
||||
* @param value The value to encode into the buffer
|
||||
*
|
||||
* @return The number of bytes used to encode @p value or @c 0 on error.
|
||||
* @return The number of bytes used to encode @p value (which can be 0
|
||||
* when encoding value of 0) or @c 0 on error.
|
||||
*/
|
||||
unsigned int coap_encode_var_safe8(uint8_t *buf,
|
||||
size_t length,
|
||||
|
||||
@@ -248,7 +248,7 @@ of the data of the option, and _data_ points to the content of the option.
|
||||
|
||||
*NOTE:* Where possible, the option data needs to be stripped of leading zeros
|
||||
(big endian) to reduce the amount of data needed in the PDU, as well as in
|
||||
some cases the maximum data size of an opton can be exceeded if not stripped
|
||||
some cases the maximum data size of an option can be exceeded if not stripped
|
||||
and hence be illegal. This is done by using coap_encode_var_safe() or
|
||||
coap_encode_var_safe8().
|
||||
|
||||
@@ -327,7 +327,7 @@ being the same or greater than the previous option _number_ that was added.
|
||||
|
||||
*NOTE:* Where possible, the option data needs to be stripped of leading zeros
|
||||
(big endian) to reduce the amount of data needed in the PDU, as well as in
|
||||
some cases the maximum data size of an opton can be exceeded if not stripped
|
||||
some cases the maximum data size of an option can be exceeded if not stripped
|
||||
and hence be illegal. This is done by using coap_encode_var_safe() or
|
||||
coap_encode_var_safe8().
|
||||
|
||||
@@ -394,10 +394,10 @@ The *coap_add_optlist*() function returns either the length of the option
|
||||
or 0 on failure.
|
||||
|
||||
The *coap_encode_var_safe*() function returns either the length of bytes
|
||||
encoded or 0 on failure.
|
||||
encoded (which can be 0 when encoding 0) or 0 on failure.
|
||||
|
||||
The *coap_encode_var_safe8*() function returns either the length of bytes
|
||||
encoded or 0 on failure.
|
||||
encoded (which can be 0 when encoding 0) or 0 on failure.
|
||||
|
||||
The *coap_send*() function returns the CoAP message ID on success or
|
||||
COAP_INVALID_MID on failure.
|
||||
|
||||
Reference in new issue
Block a user