MergeReceiver::NotifyHandler Class Reference

A base class for a class that receives notification callbacks from a sACN merge receiver. More...

#include <merge_receiver.h>

Public Member Functions
virtual void	HandleMergedData (Handle handle, const SacnRecvMergedData &merged_data)=0
	Notify that a new data packet has been received and merged.
virtual void	HandleNonDmxData (Handle receiver_handle, const etcpal::SockAddr &source_addr, const SacnRemoteSource &source_info, const SacnRecvUniverseData &universe_data)=0
	Notify that a non-data packet has been received.
virtual void	HandleSourceLimitExceeded (Handle handle, uint16_t universe)
	Notify that more than the configured maximum number of sources are currently sending on the universe being listened to.

Detailed Description

A base class for a class that receives notification callbacks from a sACN merge receiver.

Member Function Documentation

HandleMergedData()

virtual void HandleMergedData ( Handle handle, const SacnRecvMergedData & merged_data )

pure virtual

Notify that a new data packet has been received and merged.

This callback will be called in multiple ways:

1. When a new non-preview data packet or per-address priority packet is received from the sACN Receiver module, it is immediately and synchronously passed to the DMX Merger. If the sampling period has not ended, the merged result is not passed to this callback until the sampling period ends. Otherwise, it is immediately and synchronously passed to this callback.
2. When a sACN source is no longer sending non-preview data or per-address priority packets, the lost source callback from the sACN Receiver module will be passed to the merger, after which the merged result is passed to this callback pending the sampling period.

This callback should be processed quickly, since it will interfere with the receipt and processing of other sACN packets on the universe.

Parameters

[in]	handle	The merge receiver's handle.
[in]	merged_data	The merged data (and relevant information about that data), starting from the first slot of the currently configured footprint.

HandleNonDmxData()

virtual void HandleNonDmxData ( Handle receiver_handle, const etcpal::SockAddr & source_addr, const SacnRemoteSource & source_info, const SacnRecvUniverseData & universe_data )

pure virtual

Notify that a non-data packet has been received.

When an established source sends a sACN data packet that doesn't contain DMX values or priorities, the raw data within the configured footprint is immediately and synchronously passed to this callback.

This callback should be processed quickly, since it will interfere with the receipt and processing of other sACN packets on the universe.

If the source is sending sACN Sync packets, this callback will only be called when the sync packet is received, if the source forces the packet, or if the source sends a data packet without a sync universe. TODO: this version of the sACN library does not support sACN Sync. This paragraph will be valid in the future.

Parameters

[in]	receiver_handle	The merge receiver's handle.
[in]	source_addr	The network address from which the sACN packet originated.
[in]	source_info	Information about the source that sent this data.
[in]	universe_data	The universe data (and relevant information about that data), starting from the first slot of the currently configured footprint.

HandleSourceLimitExceeded()

virtual void HandleSourceLimitExceeded ( Handle handle, uint16_t universe )

inlinevirtual

Notify that more than the configured maximum number of sources are currently sending on the universe being listened to.

This is a notification that is directly forwarded from the sACN Receiver module.

Parameters

[in]	handle	The merge receiver's handle.
[in]	universe	The universe this merge receiver is monitoring.

---

The documentation for this class was generated from the following file:

• include/sacn/cpp/merge_receiver.h