RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

sys/net/cord : Update documentation

Browse Source 
Co-authored-by: Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
This commit is contained in:
Akshai M 2020-09-01 14:55:09 +05:30
parent a8e627f1c8
commit 58f6defb41
1 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
sys/include/net/cord/config.h
View File

@ -26,6 +26,11 @@
extern "C" { extern "C" {
#endif #endif
/**
* @defgroup net_cord_conf CoRE RD Client compile configurations
* @ingroup config
* @{
*/
/** /**
* @brief Default lifetime in seconds (the default is 1 day) * @brief Default lifetime in seconds (the default is 1 day)
*/ */
@ -33,6 +38,14 @@ extern "C" {
#define CONFIG_CORD_LT (86400UL) #define CONFIG_CORD_LT (86400UL)
#endif #endif
/**
* @brief Default client update interval (default is 3/4 the lifetime)
*/
#ifndef CONFIG_CORD_UPDATE_INTERVAL
#define CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3)
#endif
/** @} */
/** /**
* @brief Delay until the RD client starts to try registering (in seconds) * @brief Delay until the RD client starts to try registering (in seconds)
*/ */
@ -40,27 +53,30 @@ extern "C" {
#define CORD_STARTUP_DELAY (3U) #define CORD_STARTUP_DELAY (3U)
#endif #endif
/**
* @brief Default client update interval (default is 3/4 the lifetime)
*/
#ifndef CONFIG_CORD_UPDATE_INTERVAL
#define CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3)
#endif
/** /**
* @name Endpoint ID definition * @name Endpoint ID definition
* *
* Per default, the endpoint ID (ep) is generated by concatenation of a user * Per default, the endpoint ID (ep) is generated by concatenation of a user
* defined prefix (CORD_EP_PREFIX) and a locally unique ID (luid) encoded in * defined prefix @ref CORD_EP_PREFIX and a locally unique ID (luid) encoded in
* hexadecimal formatting with the given length of characters * hexadecimal formatting with the given length of characters
* (CORD_EP_SUFFIX_LEN). * @ref CORD_EP_SUFFIX_LEN.
* *
* Alternatively, the endpoint ID value can be defined at compile time by * Alternatively, the endpoint ID value can be defined at compile time by
* assigning a string value to the CORD_ED macro. * assigning a string value to the @ref CONFIG_CORD_EP macro.
* *
* @{ * @{
*/ */
#ifndef CONFIG_CORD_EP #ifndef CONFIG_CORD_EP
#ifdef DOXYGEN
/**
* @ingroup net_cord_conf
* @brief Endpoint ID definition
* @{
*/
#define CONFIG_CORD_EP "MyNewEpName" //defined for doxygen documentation only
#endif
/** @} */
/** /**
* @brief Number of generated hexadecimal characters added to the ep * @brief Number of generated hexadecimal characters added to the ep
* *