sACN  2.0.2
Implementation of ANSI E1.31 (Streaming ACN)
View other versions:

Macros

#define SACN_DYNAMIC_MEM   SACN_FULL_OS_AVAILABLE_HINT
 Use dynamic memory allocation. More...
 
#define SACN_LOGGING_ENABLED   1
 Enable message logging from the sACN library. More...
 
#define SACN_LOG_MSG_PREFIX   "sACN: "
 A string which will be prepended to all log messages from the sACN library.
 
#define SACN_ASSERT(expr)   assert(expr)
 The debug assert used by the sACN library. More...
 
#define SACN_ETC_PRIORITY_EXTENSION   1
 Enable ETC's per-address priority extension to sACN. More...
 
#define SACN_LOOPBACK   1
 Allow loopback of sACN to the local host (by setting the relevant socket option). More...
 
#define SACN_MAX_NETINTS   2
 The maximum number of network interfaces that can used by the sACN library. More...
 

Detailed Description

Options that apply to both sACN Source and sACN Receiver.

Macro Definition Documentation

◆ SACN_ASSERT

#define SACN_ASSERT (   expr)    assert(expr)

The debug assert used by the sACN library.

By default, just uses the C library assert. If redefining this, it must be redefined as a macro taking a single argument (the assertion expression).

◆ SACN_DYNAMIC_MEM

#define SACN_DYNAMIC_MEM   SACN_FULL_OS_AVAILABLE_HINT

Use dynamic memory allocation.

If defined nonzero, sACN manages memory dynamically using malloc() and free() from stdlib.h. Otherwise, sACN uses fixed-size pools through mempool (Memory Pools). The size of the pools is controlled with other config options.

◆ SACN_ETC_PRIORITY_EXTENSION

#define SACN_ETC_PRIORITY_EXTENSION   1

Enable ETC's per-address priority extension to sACN.

If defined nonzero, the logic of sACN Receiver changes to handle ETC's per-address priority sACN extension. An additional callback function is also enabled to be notified that a source has stopped sending per-address priority.

◆ SACN_LOGGING_ENABLED

#define SACN_LOGGING_ENABLED   1

Enable message logging from the sACN library.

If defined nonzero, the log function pointer parameter taken by sACN init functions is used to log messages from the library.

◆ SACN_LOOPBACK

#define SACN_LOOPBACK   1

Allow loopback of sACN to the local host (by setting the relevant socket option).

Most, but not all, platforms have this option enabled by default. This is necessary if a host wants to receive the same sACN it is sending.

◆ SACN_MAX_NETINTS

#define SACN_MAX_NETINTS   2

The maximum number of network interfaces that can used by the sACN library.

Meaningful only if SACN_DYNAMIC_MEM is defined to 0.