mongoose/docs/c-api/mg_coap.h/mg_coap_parse.md
Dmitry Frank 3eb4eb8074 Fix mongoose docs generation
PUBLISHED_FROM=331821dcd1f7dc8a94581cd8a9b51aa00a89fddc
2018-02-03 01:20:48 +02:00

665 B

title decl_name symbol_kind signature
mg_coap_parse() mg_coap_parse func uint32_t mg_coap_parse(struct mbuf *io, struct mg_coap_message *cm);

Parses CoAP message and fills mg_coap_message and returns cm->flags. This is a helper function.

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)

The caller has to check results and treat COAP_NOT_ENOUGH_DATA according to underlying protocol:

  • in case of UDP COAP_NOT_ENOUGH_DATA means COAP_FORMAT_ERROR,
  • in case of TCP client can try to receive more data

Return value: see mg_coap_send_message()