official
/
OpenLCP
1
0
Fork 0
Code Releases 1 Activity

comment cleanup

This commit is contained in:
Kevin Matz 2022-11-30 09:54:01 -05:00
parent d4c0665330
commit 41530d86c1
2 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
protocol/esta/sacn/source.cpp
View File

@ -41,8 +41,8 @@ Source::Source(UUID::uuid cid, std::string fctn)
Source::~Source()
{
discovery_exitSignal_.set_value();
discovery_worker_.join();
discovery_exitSignal_.set_value(); // set the exit signal for the discovery worker thread
discovery_worker_.join(); // wait for discovery to terminate normally
}

38
protocol/esta/sacn/universe.h
View File

@ -85,7 +85,7 @@ public:
ipAddress destination;
/**
* @brief The Status enum
* @brief Extend DMX::Universe::Status with the additional states of sACN.
*/
enum Status : uint8_t {
DMX_NULL = DMX::Universe::DMX_NULL, //!< uninitialized
@ -104,25 +104,27 @@ private:
Source* source_;
/**
* @brief \cite sACN 3.7 Active Data Slots
*
* > When translating ANSI E1.11 DMX512-A \cite DMX to E1.31, the active data
* > slots are defined as ranging from data slot 1 to the maximum data slot in
* > the most recently received packet with the corresponding START Code.
* >
* > Devices originating E1.31 shall define their active data slots using
* > the DMP First Property Address and DMP Property Count fields shown in
* > Table 4-1.
*/
* @brief \cite sACN 3.7 Active Data Slots
*
* > When translating ANSI E1.11 DMX512-A \cite DMX to E1.31, the active data
* > slots are defined as ranging from data slot 1 to the maximum data slot in
* > the most recently received packet with the corresponding START Code.
* >
* > Devices originating E1.31 shall define their active data slots using
* > the DMP First Property Address and DMP Property Count fields shown in
* > Table 4-1.
*/
uint16_t active_data_slots_;
/// > \cite sACN 6.3.2 E1.31 Synchronization Packet: Sequence Number
/// >
/// > Sources shall maintain a sequence for each universe they transmit.
/// > The sequence number for a universe shall be incremented by one for
/// > every packet sent on that universe. There is no implied relationship
/// > between the sequence number of an E1.31 Synchronization Packet and
/// > the sequence number of an E1.31 Data Packet on that same universe.
/**
* > \cite sACN 6.3.2 E1.31 Synchronization Packet: Sequence Number
* >
* > Sources shall maintain a sequence for each universe they transmit.
* > The sequence number for a universe shall be incremented by one for
* > every packet sent on that universe. There is no implied relationship
* > between the sequence number of an E1.31 Synchronization Packet and
* > the sequence number of an E1.31 Data Packet on that same universe.
*/
uint8_t sync_sequence_;
std::condition_variable_any tx_request_;