Compile-time configuration parameters. More...

Detailed Description

Compile-time configuration parameters.

Author: Carl Seifert carl..nosp@m.seif.nosp@m.ert@t.nosp@m.u-dr.nosp@m.esden.nosp@m..de

Definition in file config.h.

#include <assert.h>
#include "modules.h"

Include dependency graph for config.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	CONFIG_UNICOAP_BLOCK_SIZE (32)
	Block size unicoap will suggest for Block1 and Block2 transfers.

Essentials
#define	CONFIG_UNICOAP_CREATE_THREAD 1
	A configuration option determining whether a dedicated thread is created for `unicoap` on initialization.

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

#define	CONFIG_UNICOAP_ASSIST CONFIG_UNICOAP_DEBUG_LOGGING
	Catches and prints API misuse.

Ports
#define	UNICOAP_DEFAULT_COAP_PORT (5683)
	Default CoAP port.

#define	UNICOAP_DEFAULT_COAPS_PORT (5684)
	Default CoAP secure port.

#define	CONFIG_UNICOAP_UDP_PORT UNICOAP_DEFAULT_COAP_PORT
	UDP port.

#define	CONFIG_UNICOAP_DTLS_PORT UNICOAP_DEFAULT_COAPS_PORT
	DTLS port.

#define	CONFIG_UNICOAP_SOCK_ZERO_COPY_GUARANTEES IS_USED(MODULE_GNRC_SOCK_UDP)
	If enabled, guarantees sock_udp_recv_buf never returns fragmented data, i.e., the entire datagram is always fully retrieved after the first call to sock_udp_recv_buf.

#define	CONFIG_UNICOAP_GET_LOCAL_ENDPOINTS 1
	Instructs the transport drivers to retrieve the local endpoint a PDU arrives at.

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.

#define	CONFIG_UNICOAP_PDU_SIZE_MAX (128)
	Capacity of internal buffers.

#define	CONFIG_UNICOAP_WELL_KNOWN_CORE_SIZE_MAX (120)
	Maximum size of `/.well-known/core` payload.

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.

Server
See CONFIG_UNICOAP_OBSERVE_VALUE_WIDTH
#define	CONFIG_UNICOAP_PREVENT_OPTIONAL_RESPONSES 0
	Prevents unicoap from sending a response if optional, as indicated by the `No-Response` option.

#define	CONFIG_UNICOAP_WELL_KNOWN_CORE (1)
	Determines whether `unicoap` registers a default `/.well-known/core` resource.

RFC 7252 messaging
#define	CONFIG_UNICOAP_RANDOM_FACTOR_1000 (1500)
	Used to calculate upper bound for timeout.

#define	UNICOAP_TIMEOUT_ACK_RANGE_UPPER ((uint32_t)CONFIG_UNICOAP_TIMEOUT_ACK_MS * CONFIG_UNICOAP_RANDOM_FACTOR_1000 / 1000)
	Upper bound of range ACK timeouts are selected from.

#define	CONFIG_UNICOAP_TIMEOUT_ACK_MS (2000)
	Initial ACK timeout after which a given message will be retransmitted.

#define	CONFIG_UNICOAP_RETRANSMISSIONS_MAX (4)
	Maximum number of retransmissions of a confirmable message.

#define	CONFIG_UNICOAP_RFC7252_TRANSMISSIONS_MAX 2
	Maximum number of parallel message IDs that are sent and watched for reset and acknowledgment messages.

#define	CONFIG_UNICOAP_CARBON_COPIES_MAX (2)
	Maximum number of internal buffers unicoap reserves.

Session establishment
#define	CONFIG_UNICOAP_DTLS_HANDSHAKE_TIMEOUT_MS (3 * MS_PER_SEC)
	Timeout for the DTLS handshake process.

#define	CONFIG_UNICOAP_DTLS_MINIMUM_AVAILABLE_SESSION_SLOTS (1)
	Number of minimum available session slots.

#define	CONFIG_UNICOAP_DTLS_MINIMUM_AVAILABLE_SESSION_SLOTS_TIMEOUT_MS (15 * MS_PER_SEC)
	Timeout for freeing up a session when minimum number of available session slots is not available anymore.

Stack sizes
#define	UNICOAP_DTLS_EXTRA_STACKSIZE (0)
	Stack size for module thread.

#define	UNICOAP_STACK_SIZE
	Stack memory used by `unicoap` thread.

Macros