kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-25 22:43:50 +01:00
Code Releases Activity

Merge pull request #10676 from kb2ma/gcoap/doc_config_group

Browse Source 
net/gcoap: add config macros to config doc group
This commit is contained in:
Martine Lenders 2019-01-03 15:59:27 +01:00 committed by GitHub
commit 019c1aba16
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,7 +8,7 @@
*/
/**
* @defgroup net_gcoap CoAP
* @defgroup net_gcoap Gcoap
* @ingroup net
* @brief High-level interface to CoAP messaging
*
@ -231,6 +231,12 @@
extern "C" {
#endif
/**
* @defgroup net_gcoap_conf Gcoap compile configurations
* @ingroup net_gcoap
* @ingroup config
* @{
*/
/**
* @brief Size for module message queue
*/
@ -258,6 +264,7 @@ extern "C" {
#ifndef GCOAP_REQ_WAITING_MAX
#define GCOAP_REQ_WAITING_MAX (2)
#endif
/** @} */
/**
* @brief Maximum length in bytes for a token
@ -270,7 +277,10 @@ extern "C" {
#define GCOAP_HEADER_MAXLEN (sizeof(coap_hdr_t) + GCOAP_TOKENLEN_MAX)
/**
* @brief Length in bytes for a token; use 2 if not defined
* @ingroup net_gcoap_conf
* @brief Length in bytes for a token
*
* Value must be in the range 0 to @ref GCOAP_TOKENLEN_MAX.
*/
#ifndef GCOAP_TOKENLEN
#define GCOAP_TOKENLEN (2)
@ -298,6 +308,7 @@ extern "C" {
#define GCOAP_SEND_LIMIT_NON (-1)
/**
* @ingroup net_gcoap_conf
* @brief Time in usec that the event loop waits for an incoming CoAP message
*/
#ifndef GCOAP_RECV_TIMEOUT
@ -305,6 +316,7 @@ extern "C" {
#endif
/**
* @ingroup net_gcoap_conf
* @brief Default time to wait for a non-confirmable response [in usec]
*
* Set to 0 to disable timeout.
@ -327,15 +339,16 @@ extern "C" {
#define GCOAP_MSG_TYPE_INTR (0x1502)
/**
* @brief Maximum number of Observe clients; use 2 if not defined
* @ingroup net_gcoap_conf
* @brief Maximum number of Observe clients
*/
#ifndef GCOAP_OBS_CLIENTS_MAX
#define GCOAP_OBS_CLIENTS_MAX (2)
#endif
/**
* @brief Maximum number of registrations for Observable resources; use 2 if
* not defined
* @ingroup net_gcoap_conf
* @brief Maximum number of registrations for Observable resources
*/
#ifndef GCOAP_OBS_REGISTRATIONS_MAX
#define GCOAP_OBS_REGISTRATIONS_MAX (2)
@ -351,6 +364,7 @@ extern "C" {
/** @} */
/**
* @ingroup net_gcoap_conf
* @brief Width in bytes of the Observe option value for a notification
*
* This width is used to determine the length of the 'tick' used to measure
@ -402,6 +416,7 @@ extern "C" {
#endif
/**
* @ingroup net_gcoap_conf
* @brief Count of PDU buffers available for resending confirmable messages
*/
#ifndef GCOAP_RESEND_BUFS_MAX