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

Overview

A class representing a synchronous action to take in response to a received RDM command.

#include <rdmnet/cpp/common.h>

Public Member Functions

constexpr const RdmnetSyncRdmResponseget () const
 Get a const reference to the underlying C type.
 

Static Public Member Functions

static RdmResponseAction SendAck (size_t response_data_len=0)
 Send an RDM ACK, optionally including some response data. More...
 
static RdmResponseAction SendNack (rdm_nack_reason_t nack_reason)
 Send an RDM NACK with a reason code. More...
 
static RdmResponseAction SendNack (uint16_t raw_nack_reason)
 Send an RDM NACK with a reason code. More...
 
static RdmResponseAction DeferResponse ()
 Defer the RDM response to be sent later from another context. More...
 

Member Function Documentation

◆ DeferResponse()

RdmResponseAction rdmnet::RdmResponseAction::DeferResponse ( )
inlinestatic

Defer the RDM response to be sent later from another context.

Make sure to Save() any RDM command data for later processing.

◆ SendAck()

RdmResponseAction rdmnet::RdmResponseAction::SendAck ( size_t  response_data_len = 0)
inlinestatic

Send an RDM ACK, optionally including some response data.

Parameters
response_data_lenLength of the RDM response parameter data provided.
Precondition
If response_data_len != 0, data has been copied to the buffer provided at initialization time.

◆ SendNack() [1/2]

RdmResponseAction rdmnet::RdmResponseAction::SendNack ( rdm_nack_reason_t  nack_reason)
inlinestatic

Send an RDM NACK with a reason code.

Parameters
nack_reasonThe RDM NACK reason code to send with the NACK response.

◆ SendNack() [2/2]

RdmResponseAction rdmnet::RdmResponseAction::SendNack ( uint16_t  raw_nack_reason)
inlinestatic

Send an RDM NACK with a reason code.

Parameters
raw_nack_reasonThe NACK reason (either standard or manufacturer-specific) to send with the NACK response.

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