rdmnet::ClientDisconnectedInfo Class Reference

Overview

Information about a disconnect event from a broker delivered to an RDMnet callback function.

Not valid for use other than as a parameter to an RDMnet callback function. Extract the members to save them for later use.

#include <rdmnet/cpp/client.h>

Public Member Functions
	ClientDisconnectedInfo ()=delete
	Not default-constructible.
	ClientDisconnectedInfo (const ClientDisconnectedInfo &other)=delete
	Not copyable.
ClientDisconnectedInfo &	operator= (const ClientDisconnectedInfo &other)=delete
	Not copyable.
constexpr	ClientDisconnectedInfo (const RdmnetClientDisconnectedInfo &c_info) noexcept
	Construct a ClientDisconnectedInfo which references an instance of the C RdmnetClientDisconnectedInfo type.
constexpr rdmnet_disconnect_event_t	event () const noexcept
	Get the high-level reason for this disconnect.
constexpr etcpal::Error	socket_err () const noexcept
	Get the system error code associated with the disconnect. More...
constexpr rdmnet_disconnect_reason_t	rdmnet_reason () const noexcept
	Get the reason given in the RDMnet-level disconnect message. More...
constexpr bool	will_retry () const noexcept
	Whether the connection will be retried automatically. More...
constexpr bool	HasSocketErr () const noexcept
	Whether the value returned from socket_err() is valid.
constexpr bool	HasRdmnetReason () const noexcept
	Whether the value returned from rdmnet_reason() is valid.
const char *	EventToCString () const noexcept
	Get the high-level reason for this disconnect as a C-style string.
std::string	EventToString () const
	Get the high-level reason for this disconnect as a string.
const char *	RdmnetReasonToCString () const noexcept
	Get the reason given in the RDMnet-level disconnect message as a C-style string.
std::string	RdmnetReasonToString () const
	Get the reason given in the RDMnet-level disconnect message as a string.
constexpr const RdmnetClientDisconnectedInfo &	get () const noexcept
	Get a const reference to the underlying C type.

Member Function Documentation

rdmnet_reason()

constexpr rdmnet_disconnect_reason_t rdmnet::ClientDisconnectedInfo::rdmnet_reason ( ) const

constexprnoexcept

Get the reason given in the RDMnet-level disconnect message.

Valid if HasRdmnetReason() == true.

socket_err()

constexpr etcpal::Error rdmnet::ClientDisconnectedInfo::socket_err ( ) const

constexprnoexcept

Get the system error code associated with the disconnect.

Valid if HasSocketErr() == true.

will_retry()

constexpr bool rdmnet::ClientDisconnectedInfo::will_retry ( ) const

constexprnoexcept

Whether the connection will be retried automatically.

There are currently no conditions that will cause this to be false; therefore, disconnection events after a successful connection will always lead to the connection being retried automatically. This accessor exists for potential future usage.

---

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

• include/rdmnet/cpp/client.h