sACN Send Options

Macros
#define	SACN_SOURCE_THREAD_PRIORITY   ETCPAL_THREAD_DEFAULT_PRIORITY
	The priority of the sACN source thread.
#define	SACN_SOURCE_THREAD_STACK   ETCPAL_THREAD_DEFAULT_STACK
	The stack size of the sACN source thread.
#define	SACN_SOURCE_THREAD_NAME   "sACN Source Thread"
	The name to assign the sACN source thread.
#define	SACN_SOURCE_SOCKET_SNDBUF_SIZE   115000
	The size of the send buffer to use for sockets that send sACN over multicast and unicast.
#define	SACN_SOURCE_MAX_SOURCES   1
	The maximum number of sources that can be created.
#define	SACN_SOURCE_MAX_UNIVERSES_PER_SOURCE   4
	The maximum number of universes that a source can send to simultaneously.
#define	SACN_MAX_UNICAST_DESTINATIONS_PER_UNIVERSE   4
	The maximum number of unicast destinations per universe that a source can send to simultaneously.

Detailed Description

Configuration options for the sACN Source module.

Macro Definition Documentation

SACN_MAX_UNICAST_DESTINATIONS_PER_UNIVERSE

#define SACN_MAX_UNICAST_DESTINATIONS_PER_UNIVERSE   4

The maximum number of unicast destinations per universe that a source can send to simultaneously.

Meaningful only if SACN_DYNAMIC_MEM is defined to 0.

SACN_SOURCE_MAX_SOURCES

#define SACN_SOURCE_MAX_SOURCES   1

The maximum number of sources that can be created.

If this is set to 0, the Source API is disabled and no memory pools are allocated for it.

Meaningful only if SACN_DYNAMIC_MEM is defined to 0.

SACN_SOURCE_MAX_UNIVERSES_PER_SOURCE

#define SACN_SOURCE_MAX_UNIVERSES_PER_SOURCE   4

The maximum number of universes that a source can send to simultaneously.

If this is set to 0, the Source API is disabled and no memory pools are allocated for it.

Meaningful only if SACN_DYNAMIC_MEM is defined to 0.

SACN_SOURCE_SOCKET_SNDBUF_SIZE

#define SACN_SOURCE_SOCKET_SNDBUF_SIZE   115000

The size of the send buffer to use for sockets that send sACN over multicast and unicast.

This buffer size will only be used on Windows, Mac, and Linux. This isn't used for embedded platforms since their support for SO_SNDBUF is sparse and more limited.

Increasing this can improve the performance of sACN sources when sending a large number of universes. The default chosen for this (115000) was determined to be sufficient to prevent the send buffer from getting full when running 1 source to 100 universes at 1 unicast destination.

SACN_SOURCE_THREAD_NAME

#define SACN_SOURCE_THREAD_NAME   "sACN Source Thread"

The name to assign the sACN source thread.

This is useful for distinguishing the source thread from other threads when debugging.

SACN_SOURCE_THREAD_PRIORITY

#define SACN_SOURCE_THREAD_PRIORITY   ETCPAL_THREAD_DEFAULT_PRIORITY

The priority of the sACN source thread.

This is usually only meaningful on real-time systems.

SACN_SOURCE_THREAD_STACK

#define SACN_SOURCE_THREAD_STACK   ETCPAL_THREAD_DEFAULT_STACK

The stack size of the sACN source thread.

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