riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

net/gcoap: improve documentation

Browse Source 
add hint to alphabetical ordering of resources
This commit is contained in:
Lasse Lueder 2018-03-27 21:25:47 +02:00
parent 217c6a70a5
commit a456c19898
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
sys/include/net/gcoap.h
View File

@ -44,9 +44,10 @@
* this by uncommenting the appropriate lines in gcoap's make file.
*
* gcoap allows an application to specify a collection of request resource paths
* it wants to be notified about. Create an array of resources, coap_resource_t
* structs. Use gcoap_register_listener() at application startup to pass in
* these resources, wrapped in a gcoap_listener_t.
* it wants to be notified about. Create an array of resources (coap_resource_t
* structs). Note that the elements must be ordered alphabetically with respect
* to the resource path. Use gcoap_register_listener() at application startup
* to pass in these resources, wrapped in a gcoap_listener_t.
*
* gcoap itself defines a resource for `/.well-known/core` discovery, which
* lists all of the registered paths.