Overview

Information provided by the library about an unsuccessful RDMnet client connection.

Data Fields
rdmnet_connect_fail_event_t	event

etcpal_error_t	socket_err
	The system error code associated with the failure. More...

rdmnet_connect_status_t	rdmnet_reason
	The reason given in the RDMnet-level connection refuse message. More...

bool	will_retry
	Whether the connection will be retried automatically. More...

Field Documentation

◆ event

rdmnet_connect_fail_event_t event

The high-level reason that this connection failed.

◆ rdmnet_reason

rdmnet_connect_status_t rdmnet_reason

The reason given in the RDMnet-level connection refuse message.

Valid if event is kRdmnetConnectFailRejected.

◆ socket_err

etcpal_error_t socket_err

The system error code associated with the failure.

Valid if event is kRdmnetConnectFailSocketFailure or kRdmnetConnectFailTcpLevel.

◆ will_retry

bool will_retry

Whether the connection will be retried automatically.

If this is true, the connection will be retried on the same scope; expect further notifications of connection success or failure. If false, the rdmnet_client_scope_t handle associated with the scope is invalidated, and the scope must be created again. This indicates that the connection failed for a reason that usually must be corrected by a user or application developer. Some possible reasons for this to be false include:

The wrong scope was specified for a statically-configured broker
A static UID was given that was invalid

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