Customize limits and capabilities of unicoap. More...

Detailed Description

Customize limits and capabilities of unicoap.

Files
file	config.h
	Compile-time configuration parameters.

Essentials
#define	CONFIG_UNICOAP_DEBUG_LOGGING 0
	Enables debug logging in all `unicoap` source files, except where locally overwritten.

Limits
#define	CONFIG_UNICOAP_OPTIONS_MAX (16)
	Maximum number of options that can be present in a request or response.

#define	CONFIG_UNICOAP_OPTIONS_BUFFER_DEFAULT_CAPACITY (32)
	Default buffer capacity unicoap chooses when you invoke UNICOAP_OPTIONS_ALLOC_DEFAULT.

#define	UNICOAP_HEADER_SIZE_MAX (15)
	Size of buffer unicoap allocates for a CoAP message header, including token length.

#define	CONFIG_UNICOAP_EXTERNAL_TOKEN_LENGTH_MAX (8)
	Maximum length of a token received from a client.

#define	CONFIG_UNICOAP_GENERATED_TOKEN_LENGTH (2)
	Length of tokens generated by the unicoap client API.

#define	UNICOAP_ETAG_LENGTH_FIXED_WIDTH 4
	Numbers of bits needed to represent a given ETag's length.

Timing
These parameters are defined as being configurable in [RFC 7252, section 4.8.1] (https://tools.ietf.org/html/rfc7252#section-4.8.1).
#define	UNICOAP_NSTART (1)
	`NSTART` constant for multicast delay calculation

#define	UNICOAP_DEFAULT_LEISURE (5)
	`DEFAULT_LEISURE` constant for multicast delay calculation

Resource observation
#define	CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH (3)
	Width in bytes of the Observe option value for a notification.

Macro Definition Documentation

◆ CONFIG_UNICOAP_DEBUG_LOGGING

#define CONFIG_UNICOAP_DEBUG_LOGGING 0

Enables debug logging in all unicoap source files, except where locally overwritten.

Default: enabled

Definition at line 41 of file config.h.

◆ CONFIG_UNICOAP_EXTERNAL_TOKEN_LENGTH_MAX

#define CONFIG_UNICOAP_EXTERNAL_TOKEN_LENGTH_MAX (8)

Maximum length of a token received from a client.

Default: 8 bytes

Definition at line 86 of file config.h.

◆ CONFIG_UNICOAP_GENERATED_TOKEN_LENGTH

#define CONFIG_UNICOAP_GENERATED_TOKEN_LENGTH (2)

Length of tokens generated by the unicoap client API.

Default: 2 bytes

Definition at line 98 of file config.h.

◆ CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH

#define CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH (3)

Width in bytes of the Observe option value for a notification.

Maximum allowed value: 3 bytes

Definition at line 141 of file config.h.

◆ CONFIG_UNICOAP_OPTIONS_BUFFER_DEFAULT_CAPACITY

#define CONFIG_UNICOAP_OPTIONS_BUFFER_DEFAULT_CAPACITY (32)

Default buffer capacity unicoap chooses when you invoke UNICOAP_OPTIONS_ALLOC_DEFAULT.

Options are stored in a contiguous memory region according to the format specified in RFC 7252, Section 3.1. This parameter does not affect UNICOAP_OPTIONS_ALLOC.

Default: 32 bytes

Definition at line 69 of file config.h.

◆ CONFIG_UNICOAP_OPTIONS_MAX

#define CONFIG_UNICOAP_OPTIONS_MAX (16)

Maximum number of options that can be present in a request or response.

Default: 16 options

Definition at line 56 of file config.h.

◆ UNICOAP_DEFAULT_LEISURE

#define UNICOAP_DEFAULT_LEISURE (5)

DEFAULT_LEISURE constant for multicast delay calculation

Definition at line 127 of file config.h.

◆ UNICOAP_ETAG_LENGTH_FIXED_WIDTH

#define UNICOAP_ETAG_LENGTH_FIXED_WIDTH 4

Numbers of bits needed to represent a given ETag's length.

Definition at line 107 of file config.h.

◆ UNICOAP_HEADER_SIZE_MAX

#define UNICOAP_HEADER_SIZE_MAX (15)

Size of buffer unicoap allocates for a CoAP message header, including token length.

Definition at line 76 of file config.h.

◆ UNICOAP_NSTART

#define UNICOAP_NSTART (1)

NSTART constant for multicast delay calculation

Definition at line 122 of file config.h.