source_detector.h File Reference

sACN Source Detector API definitions More...

#include <stdbool.h>
#include <stdint.h>
#include "etcpal/error.h"
#include "etcpal/inet.h"
#include "etcpal/log.h"
#include "etcpal/netint.h"
#include "etcpal/uuid.h"
#include "sacn/common.h"

Go to the source code of this file.

Classes
struct	SacnSourceDetectorCallbacks
	A set of callback functions that the library uses to notify the application about source detector events. More...
struct	SacnSourceDetectorConfig
	A set of configuration information for the sACN Source Detector. More...

Macros
#define	SACN_SOURCE_DETECTOR_CONFIG_DEFAULT_INIT    {{NULL, NULL, NULL, NULL}, kSacnSourceDetectorInfinite, kSacnSourceDetectorInfinite, kSacnIpV4AndIpV6}
	A default-value initializer for an SacnSourceDetectorConfig struct.

Typedefs
typedef void(*	SacnSourceDetectorSourceUpdatedCallback) (sacn_remote_source_t handle, const EtcPalUuid *cid, const char *name, const uint16_t *sourced_universes, size_t num_sourced_universes, void *context)
	Notify that a source is new or has changed.
typedef void(*	SacnSourceDetectorSourceExpiredCallback) (sacn_remote_source_t handle, const EtcPalUuid *cid, const char *name, void *context)
	Notify that a source is no longer transmitting Universe Discovery messages.
typedef void(*	SacnSourceDetectorLimitExceededCallback) (void *context)
	Notify that the module has run out of memory to track universes or sources.
typedef struct SacnSourceDetectorCallbacks	SacnSourceDetectorCallbacks
	A set of callback functions that the library uses to notify the application about source detector events.
typedef struct SacnSourceDetectorConfig	SacnSourceDetectorConfig
	A set of configuration information for the sACN Source Detector.

Enumerations
enum	{ kSacnSourceDetectorInfinite = 0 }

Functions
void	sacn_source_detector_config_init (SacnSourceDetectorConfig *config)
	Initialize an sACN Source Detector Config struct to default values.
etcpal_error_t	sacn_source_detector_create (const SacnSourceDetectorConfig *config, const SacnNetintConfig *netint_config)
	Create the sACN Source Detector.
void	sacn_source_detector_destroy ()
	Destroy the sACN Source Detector.
etcpal_error_t	sacn_source_detector_reset_networking (const SacnNetintConfig *sys_netint_config)
	Updates the source detector system network interfaces.
size_t	sacn_source_detector_get_network_interfaces (EtcPalMcastNetintId *netints, size_t netints_size)
	Obtain the source detector's network interfaces.

Detailed Description

sACN Source Detector API definitions

Functions and definitions for the sACN Source Detector API are contained in this header.