Core

Overview

Options that affect the RDMnet core library.

Any options with *_MAX_* in the name are applicable only to compilations with dynamic memory disabled (RDMNET_DYNAMIC_MEM = 0, most common in embedded toolchains).

Macros
#define	RDMNET_PARSER_MAX_CLIENT_ENTRIES   5
	The maximum number of ClientEntryData structures that can be returned with a parsed message. More...
#define	RDMNET_PARSER_MAX_EPT_SUBPROTS   5
	The maximum number of RdmnetEptSubProtocol structures that can be returned with a parsed message. More...
#define	RDMNET_PARSER_MAX_DYNAMIC_UID_ENTRIES   5
	The maximum number of Dynamic-UID-related structures that can be returned with a parsed message. More...
#define	RDMNET_PARSER_MAX_ACK_OVERFLOW_RESPONSES   5
	The maximum number of RdmCmdListEntry structures that can be returned with a parsed ACK_OVERFLOW response (e.g. More...
#define	RDMNET_MAX_MCAST_NETINTS   3
	The maximum number of network interfaces usable for RDMnet's multicast protocols. More...
#define	RDMNET_BIND_MCAST_SOCKETS_TO_MCAST_ADDRESS   !RDMNET_WINDOWS_HINT
	For multicast protocols, whether to bind the underlying network socket directly to the multicast address. More...
#define	RDMNET_TICK_THREAD_PRIORITY   ETCPAL_THREAD_DEFAULT_PRIORITY
	The priority of the tick thread. More...
#define	RDMNET_TICK_THREAD_STACK   (ETCPAL_THREAD_DEFAULT_STACK * 2)
	The stack size of the tick thread. More...

Macro Definition Documentation

RDMNET_BIND_MCAST_SOCKETS_TO_MCAST_ADDRESS

#define RDMNET_BIND_MCAST_SOCKETS_TO_MCAST_ADDRESS   !RDMNET_WINDOWS_HINT

For multicast protocols, whether to bind the underlying network socket directly to the multicast address.

Otherwise, the socket is bound to the wildcard address. On some systems, binding directly to a multicast address decreases traffic duplication. On other systems, it's not even allowed. Leave this option at its default value unless you REALLY know what you're doing.

RDMNET_MAX_MCAST_NETINTS

#define RDMNET_MAX_MCAST_NETINTS   3

The maximum number of network interfaces usable for RDMnet's multicast protocols.

RDMnet makes use of two multicast protocols, LLRP and mDNS. These protocols require tracking of local network interfaces when creating network sockets.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0.

RDMNET_PARSER_MAX_ACK_OVERFLOW_RESPONSES

#define RDMNET_PARSER_MAX_ACK_OVERFLOW_RESPONSES   5

The maximum number of RdmCmdListEntry structures that can be returned with a parsed ACK_OVERFLOW response (e.g.

from an RPT Notification message).

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0. If an RDMnet response is received with more ACK_OVERFLOW responses than this number, they will be delivered in batches of this number with the "partial" flag set to true on all but the last batch.

RDMNET_PARSER_MAX_CLIENT_ENTRIES

#define RDMNET_PARSER_MAX_CLIENT_ENTRIES   5

The maximum number of ClientEntryData structures that can be returned with a parsed message.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0.

RDMNET_PARSER_MAX_DYNAMIC_UID_ENTRIES

#define RDMNET_PARSER_MAX_DYNAMIC_UID_ENTRIES   5

The maximum number of Dynamic-UID-related structures that can be returned with a parsed message.

This option applies to BrokerDynamicUidRequestListEntry, BrokerDynamicUidMapping, and BrokerFetchUidAssignmentListEntry structures. Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0.

RDMNET_PARSER_MAX_EPT_SUBPROTS

#define RDMNET_PARSER_MAX_EPT_SUBPROTS   5

The maximum number of RdmnetEptSubProtocol structures that can be returned with a parsed message.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0.

RDMNET_TICK_THREAD_PRIORITY

#define RDMNET_TICK_THREAD_PRIORITY   ETCPAL_THREAD_DEFAULT_PRIORITY

The priority of the tick thread.

This is usually only meaningful on real-time systems.

RDMNET_TICK_THREAD_STACK

#define RDMNET_TICK_THREAD_STACK   (ETCPAL_THREAD_DEFAULT_STACK * 2)

The stack size of the tick thread.

It's usually only necessary to worry about this on real-time or embedded systems.