Configuration options for CoRE RD endpoints and lookup clients. More...

Detailed Description

Configuration options for CoRE RD endpoints and lookup clients.

Files
file	config.h
	(Default) configuration values for CoRE RD endpoints and lookup clients

Macros
#define	CONFIG_CORD_LT (86400UL)
	Default lifetime in seconds (the default is 1 day)

#define	CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3)
	Default client update interval (default is 3/4 the lifetime)

#define	CORD_STARTUP_DELAY (3U)
	Delay until the RD client starts to try registering (in seconds)

#define	CONFIG_CORD_EXTRAARGS
	Extra query parameters added during registration.

Endpoint ID definition
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 hexadecimal formatting with the given length of characters CORD_EP_SUFFIX_LEN. Alternatively, the endpoint ID value can be defined at compile time by assigning a string value to the CONFIG_CORD_EP macro.
#define	CONFIG_CORD_EP "MyNewEpName"
	Endpoint ID definition.

#define	CORD_EP_SUFFIX_LEN (16)
	Number of generated hexadecimal characters added to the ep.

#define	CORD_EP_PREFIX "RIOT-"
	Default static prefix used for the generated ep.

Macro Definition Documentation

◆ CONFIG_CORD_EP

#define CONFIG_CORD_EP "MyNewEpName"

Endpoint ID definition.

Definition at line 69 of file config.h.

◆ CONFIG_CORD_EXTRAARGS

#define CONFIG_CORD_EXTRAARGS

Extra query parameters added during registration.

Must be suitable for constructing a static array out of them. Each item of the array is turned as a Uri-Query option. The IANA RD Parameters subregistry contains usable keys and their descriptions in entries that have an "R" in their "Use" column. Other keys can be used with known RD implementations.

The ep and lt parameters are not to be set through this mechanism, but through CONFIG_CORD_EP and CONFIG_CORD_LT, respectively.

Example:

CFLAGS += '-DCONFIG_CORD_EXTRAARGS="proxy=on","et=tag:riot-os.org,2020:board"'

Definition at line 106 of file config.h.

◆ CONFIG_CORD_LT

#define CONFIG_CORD_LT (86400UL)

Default lifetime in seconds (the default is 1 day)

Definition at line 34 of file config.h.

◆ CONFIG_CORD_UPDATE_INTERVAL

#define CONFIG_CORD_UPDATE_INTERVAL ((CONFIG_CORD_LT / 4) * 3)

Default client update interval (default is 3/4 the lifetime)

Definition at line 41 of file config.h.

◆ CORD_EP_PREFIX

#define CORD_EP_PREFIX "RIOT-"

Default static prefix used for the generated ep.

Definition at line 82 of file config.h.

◆ CORD_EP_SUFFIX_LEN

#define CORD_EP_SUFFIX_LEN (16)

Number of generated hexadecimal characters added to the ep.

Note: Must be an even number

Definition at line 77 of file config.h.

◆ CORD_STARTUP_DELAY

#define CORD_STARTUP_DELAY (3U)

Delay until the RD client starts to try registering (in seconds)

Definition at line 48 of file config.h.