Skip to content

M
mongoose
Commit a5c697fa authored by Evelyn's avatar Evelyn Committed by GitHub
Browse files
Options

Update mg_coap_parse.md

parent be199b4f
Hide whitespace changes
Inline Side-by-side
Showing with 4 additions and 4 deletions
docs/c-api/coap.h/mg_coap_parse.md
View file @ a5c697fa
...@@ -6,13 +6,13 @@ signature: | ...@@ -6,13 +6,13 @@ signature: |
uint32_t mg_coap_parse(struct mbuf *io, struct mg_coap_message *cm); uint32_t mg_coap_parse(struct mbuf *io, struct mg_coap_message *cm);
--- ---
Parse COAP message and fills mg_coap_message and returns cm->flags. Parses CoAP message and fills mg_coap_message and returns cm->flags.
This is a helper function. This is a helper function.
NOTE: usually CoAP work over UDP, so lack of data means format error, NOTE: usually CoAP works over UDP, so lack of data means format error.
but in theory it is possible to use CoAP over TCP (according to RFC) But, in theory, it is possible to use CoAP over TCP (according to RFC)
The caller have to check results and treat COAP_NOT_ENOUGH_DATA according to The caller has to check results and treat COAP_NOT_ENOUGH_DATA according to
underlying protocol: underlying protocol:
- in case of UDP COAP_NOT_ENOUGH_DATA means COAP_FORMAT_ERROR, - in case of UDP COAP_NOT_ENOUGH_DATA means COAP_FORMAT_ERROR,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment