official
/
OpenLCP
1
0
Fork 0
Code Releases 1 Activity

doc updates

This commit is contained in:
Kevin Matz 2022-11-20 15:15:14 -05:00
parent ae838bee21
commit 1ad91bdefe
2 changed files with 23 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
protocol/rlp/component.cpp
View File

@ -53,9 +53,9 @@ void Component::UdpPayloadReceiver(PDU::Stream stream)
auto transport = RLP::UDP::transport();
transport.iStream(stream);
for(auto const &root : *transport.root.pdu) {
/// The RLP PDU Block will only contain suscessfully read PDU
for(auto const &root : *transport.root.pdu)
RlpReceiver(root);
}
}
@ -85,9 +85,9 @@ void Component::TcpPacketReceiver(PDU::Stream stream)
auto transport = RLP::TCP::transport();
transport.iStream(stream);
for(auto const &root : *transport.root.pdu) {
/// The RLP PDU Block will only contain suscessfully read PDU
for(auto const &root : *transport.root.pdu)
RlpReceiver(root);
}
}
@ -119,9 +119,14 @@ void Component::RlpReceiver(PDU::Message<RLP::Pdu> root)
if (!root->stream()->good())
return;
if (rlp_vectors_.count(root->vector()))
for(auto const &handler : rlp_vectors_[root->vector()])
handler(root);
/// PDU with unregistered vectors are ignored.
if (!rlp_vectors_.count(root->vector()))
return;
/// The root PDU is passed to every registered handler for the vector, in the
/// order in which the handlers were registered.
for(const auto &handler : rlp_vectors_[root->vector()])
handler(root);
}

22
protocol/sacn/arbitratinguniverse.cpp
View File

@ -27,7 +27,7 @@
namespace sACN {
/**
* @brief MergeProxyUniverse::MergeProxyUniverse
* @brief ArbitratingUniverse::MergeProxyUniverse
*/
ArbitratingUniverse::ArbitratingUniverse()
: sACN::Universe()
@ -38,7 +38,7 @@ ArbitratingUniverse::ArbitratingUniverse()
/**
* @brief MergeProxyUniverse::~MergeProxyUniverse
* @brief ArbitratingUniverse::~MergeProxyUniverse
*/
ArbitratingUniverse::~ArbitratingUniverse()
{
@ -75,7 +75,7 @@ const std::vector<DATA::data_header> ArbitratingUniverse::sources() const
/**
* @brief MergeProxyUniverse::sourceUniverse
* @brief ArbitratingUniverse::sourceUniverse
* @param src
* @return
*/
@ -89,7 +89,7 @@ std::shared_ptr<Universe> ArbitratingUniverse::sourceUniverse(const DATA::data_h
/**
* @brief MergeProxyUniverse::hasSourceUniverse
* @brief ArbitratingUniverse::hasSourceUniverse
* @param src
* @return
*/
@ -112,7 +112,7 @@ std::shared_ptr<Universe> ArbitratingUniverse::addNewSource(const DATA::data_hea
/**
* @brief MergeProxyUniverse::deleteSourceUniverse
* @brief ArbitratingUniverse::deleteSourceUniverse
* @param src
*/
void ArbitratingUniverse::deleteSourceUniverse(const DATA::data_header& src)
@ -128,7 +128,7 @@ void ArbitratingUniverse::deleteSourceUniverse(const DATA::data_header& src)
/**
* @brief MergeProxyUniverse::dataChangedNotifier
* @brief ArbitratingUniverse::dataChangedNotifier
* @param dmx
*/
void ArbitratingUniverse::dataChangedNotifier(DMX::Universe* dmx)
@ -179,7 +179,7 @@ void ArbitratingUniverse::doListChangeCallbacks()
/**
* @brief MergeProxyUniverse::isSyncronized
* @brief ArbitratingUniverse::isSyncronized
* @return
*/
bool ArbitratingUniverse::isSyncronized()
@ -192,7 +192,7 @@ bool ArbitratingUniverse::isSyncronized()
/**
* @brief MergeProxyUniverse::provenance
* @brief ArbitratingUniverse::provenance
* @return
*/
std::shared_ptr<DATA::data_header> ArbitratingUniverse::provenance()
@ -210,7 +210,7 @@ std::shared_ptr<DATA::data_header> ArbitratingUniverse::provenance()
/**
* @brief MergeProxyUniverse::set
* @brief ArbitratingUniverse::set
* @param pdu
* @param src
*/
@ -254,7 +254,7 @@ uint16_t ArbitratingUniverse::activeSlots()
/**
* @brief MergeProxyUniverse::slot
* @brief ArbitratingUniverse::slot
* @param s
* @return
*/
@ -268,7 +268,7 @@ uint8_t ArbitratingUniverse::slot(const uint16_t s)
/**
* @brief MergeProxyUniverse::rxRate
* @brief ArbitratingUniverse::rxRate
* @return
*/
double ArbitratingUniverse::rxRate()