[riot-notifications] [RIOT-OS/RIOT] net/nanocoap: group functions in module doc (#10876)

Ken Bannister notifications at github.com
Sat Apr 20 02:44:03 CEST 2019

kb2ma commented on this pull request.

> + * nanocoap sock uses the nanocoap CoAP library to provide a synchronous
+ * interface to RIOT's sock networking API to read and write CoAP messages.
+ * For a server, nanocoap sock accepts a list of resource paths with callbacks
+ * for writing the response. For a client, nanocoap sock provides a function
+ * to send a request and waits for the server response.
+ *
+ * ## Server Operation ##
+ *
+ * See the nanocoap_server example, which is built on the nanocoap_server()
+ * function. A server must define an array of coap_resource_t resources for
+ * which it responds. See the declarations of `coap_resources` and
+ * `coap_resources_numof`. The array contents must be ordered by the resource
+ * path, specifically the ASCII encoding of the path characters (digit and
+ * capital precede lower case). nanocoap provides the
+ * COAP_WELL_KNOWN_CORE_DEFAULT_HANDLER entry for `/.well-known/core`.
+ *

Good catch, Leandro!

I left the path matching section in the base nanocoap doc and added references in the nanocoap sock and gcoap docs. There was too much text in that section to duplicate.

You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190419/6408cc45/attachment.html>

More information about the notifications mailing list