From a5c697fa2ded87f25000a6c4b064f36584ec0a4b Mon Sep 17 00:00:00 2001 From: Evelyn Date: Mon, 25 Jul 2016 17:28:59 +0100 Subject: [PATCH] Update mg_coap_parse.md --- docs/c-api/coap.h/mg_coap_parse.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/c-api/coap.h/mg_coap_parse.md b/docs/c-api/coap.h/mg_coap_parse.md index 2f3bc0c6..86885229 100644 --- a/docs/c-api/coap.h/mg_coap_parse.md +++ b/docs/c-api/coap.h/mg_coap_parse.md @@ -6,13 +6,13 @@ signature: | 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. -NOTE: usually CoAP work over UDP, so lack of data means format error, -but in theory it is possible to use CoAP over TCP (according to RFC) +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 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: - in case of UDP COAP_NOT_ENOUGH_DATA means COAP_FORMAT_ERROR,