RDMnet  0.3.0
Implementation of ANSI E1.33 (RDMnet)
View other versions:
rdmnet::EptData Class Reference

Overview

An EPT data message received over RDMnet and delivered to an RDMnet callback function.

Not valid for use other than as a parameter to an RDMnet callback function; use EptData::Save() to create a copyable version.

#include <rdmnet/cpp/message_types/ept_data.h>

Public Member Functions

 EptData ()=delete
 Not default-constructible.
 
 EptData (const EptData &other)=delete
 Not copyable - use Save() to create a copyable version.
 
EptDataoperator= (const EptData &other)=delete
 Not copyable - use Save() to create a copyable version.
 
constexpr EptData (const RdmnetEptData &c_data) noexcept
 Construct an EptData copied from an instance of the C RdmnetEptData type.
 
constexpr etcpal::Uuid source_cid () const noexcept
 Get the CID of the EPT client that sent this data.
 
constexpr uint16_t manufacturer_id () const noexcept
 Get the ESTA manufacturer ID that identifies the EPT sub-protocol.
 
constexpr uint16_t protocol_id () const noexcept
 Get the protocol ID that identifies the EPT sub-protocol.
 
constexpr uint32_t sub_protocol () const noexcept
 Get the full EPT sub-protocol identifier. More...
 
constexpr const uint8_t * data () const noexcept
 Get the data associated with this EPT message.
 
constexpr size_t data_len () const noexcept
 Get the length of the data associated with this EPT message.
 
std::vector< uint8_t > CopyData () const
 Copy the data out of an EPT data message. More...
 
constexpr const RdmnetEptDataget () const noexcept
 Get a const reference to the underlying C type.
 
SavedEptData Save () const
 Save this data message for later use from a different context. More...
 

Member Function Documentation

◆ CopyData()

std::vector< uint8_t > rdmnet::EptData::CopyData ( ) const
inline

Copy the data out of an EPT data message.

Returns
A new vector of bytes representing the EPT data.

◆ Save()

SavedEptData rdmnet::EptData::Save ( ) const
inline

Save this data message for later use from a different context.

Returns
A SavedEptData containing the copied data.

◆ sub_protocol()

constexpr uint32_t rdmnet::EptData::sub_protocol ( ) const
constexprnoexcept

Get the full EPT sub-protocol identifier.

Equivalent to (manufacturer_id() << 16 | protocol_id())


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