RdmnetClientDisconnectedInfo Struct Reference

Overview

Information provided by the library about an RDMnet client connection that disconnected after a successful connection.

#include <rdmnet/client.h>

Data Fields
rdmnet_disconnect_event_t	event
	The high-level reason for the disconnect.
etcpal_error_t	socket_err
	The system error code associated with the disconnect. More...
rdmnet_disconnect_reason_t	rdmnet_reason
	The reason given in the RDMnet-level disconnect message. More...
bool	will_retry
	Whether the connection will be retried automatically. More...

Field Documentation

rdmnet_reason

rdmnet_disconnect_reason_t RdmnetClientDisconnectedInfo::rdmnet_reason

The reason given in the RDMnet-level disconnect message.

Valid if event is kRdmnetDisconnectGracefulRemoteInitiated.

socket_err

etcpal_error_t RdmnetClientDisconnectedInfo::socket_err

The system error code associated with the disconnect.

Valid if event is kRdmnetDisconnectAbruptClose.

will_retry

bool RdmnetClientDisconnectedInfo::will_retry

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 field exists for potential future usage.

---

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

• include/rdmnet/client.h