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

Overview

An EPT data message received over RDMnet and saved for later processing.

This type is not used by the library API, but can come in handy if an application wants to queue or copy EPT data messages before acting on them. This type does heap allocation to hold the data.

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

Public Member Functions

 SavedEptData ()=default
 Constructs an empty, invalid EPT data structure by default.
 
 SavedEptData (const RdmnetSavedEptData &c_data)
 Construct a SavedEptData copied from an instance of the C RdmnetSavedEptData type.
 
SavedEptDataoperator= (const RdmnetSavedEptData &c_data)
 Assign an instance of the C RdmnetSavedEptData type to an instance of this class.
 
 SavedEptData (const EptData &resp)
 Construct a SavedEptData from an EptData.
 
SavedEptDataoperator= (const EptData &resp)
 Assign an EptData to an instance of this class.
 
const etcpal::Uuidsource_cid () const noexcept
 Get the CID of the EPT client that sent this data.
 
uint16_t manufacturer_id () const noexcept
 Get the ESTA manufacturer ID that identifies the EPT sub-protocol.
 
uint16_t protocol_id () const noexcept
 Get the protocol ID that identifies the EPT sub-protocol.
 
uint32_t sub_protocol () const noexcept
 Get the full EPT sub-protocol identifier. More...
 
const uint8_t * data () const noexcept
 Get the data associated with this EPT message.
 
size_t data_len () const noexcept
 Get the length of the data associated with this EPT message.
 
bool IsValid () const noexcept
 Whether the values contained in this class are valid for an EPT data message.
 

Member Function Documentation

◆ sub_protocol()

uint32_t rdmnet::SavedEptData::sub_protocol ( ) const
inlinenoexcept

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: