Client

Overview

Options that affect the RDMnet Client APIs.

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_MAX_CONTROLLERS   0
	The maximum number of RDMnet Controller instances that an application can create. More...
#define	RDMNET_MAX_DEVICES   1
	The maximum number of RDMnet Device instances that an application can create. More...
#define	RDMNET_MAX_EPT_CLIENTS   0
	The maximum number of EPT Client instances that an application can create. More...
#define	RDMNET_MAX_SCOPES_PER_CONTROLLER   1
	The maximum number of scopes on which each controller instance can communicate. More...
#define	RDMNET_MAX_ENDPOINTS_PER_DEVICE   1
	The maximum number of nonzero endpoints that can be added to each device instance. More...
#define	RDMNET_MAX_RESPONDERS_PER_DEVICE_ENDPOINT   1
	The maximum number of responders that can be added to each device endpoint. More...
#define	RDMNET_MAX_PROTOCOLS_PER_EPT_CLIENT   5
	The maximum number of EPT sub-protocols supported on a local EPT client instance. More...
#define	RDMNET_MAX_SENT_ACK_OVERFLOW_RESPONSES   2
	The maximum number of RDM responses that can be sent from an RPT Client at once in an ACK_OVERFLOW response. More...

Macro Definition Documentation

RDMNET_MAX_CONTROLLERS

#define RDMNET_MAX_CONTROLLERS   0

The maximum number of RDMnet Controller instances that an application can create.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0. A typical application will only need one controller instance (which can communicate on an arbitrary number of scopes).

RDMNET_MAX_DEVICES

#define RDMNET_MAX_DEVICES   1

The maximum number of RDMnet Device instances that an application can create.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0. A typical application will only need one device instance.

RDMNET_MAX_ENDPOINTS_PER_DEVICE

#define RDMNET_MAX_ENDPOINTS_PER_DEVICE   1

The maximum number of nonzero endpoints that can be added to each device instance.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0.

RDMNET_MAX_EPT_CLIENTS

#define RDMNET_MAX_EPT_CLIENTS   0

The maximum number of EPT Client instances that an application can create.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0.

RDMNET_MAX_PROTOCOLS_PER_EPT_CLIENT

#define RDMNET_MAX_PROTOCOLS_PER_EPT_CLIENT   5

The maximum number of EPT sub-protocols supported on a local EPT client instance.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0.

RDMNET_MAX_RESPONDERS_PER_DEVICE_ENDPOINT

#define RDMNET_MAX_RESPONDERS_PER_DEVICE_ENDPOINT   1

The maximum number of responders that can be added to each device endpoint.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0.

RDMNET_MAX_SCOPES_PER_CONTROLLER

#define RDMNET_MAX_SCOPES_PER_CONTROLLER   1

The maximum number of scopes on which each controller instance can communicate.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0.

RDMNET_MAX_SENT_ACK_OVERFLOW_RESPONSES

#define RDMNET_MAX_SENT_ACK_OVERFLOW_RESPONSES   2

The maximum number of RDM responses that can be sent from an RPT Client at once in an ACK_OVERFLOW response.

Meaningful only if RDMNET_DYNAMIC_MEM is defined to 0. For applications which desire static memory, this parameter should be set to the maximum number of RDM ACK_OVERFLOW responses the application ever anticipates generating in response to an RDMnet request, based on the client's parameter data. Since RDMnet gateways cannot anticipate how many ACK_OVERFLOW responses will be received from a downstream RDM responder, a reasonable guess may need to be made based on the RDM standard.