Enum ConnectionStopReason

Why the client stopped, on the notification that says it stopped.

Namespace: Xrpl.Client
Assembly: Xrpl.dll
Syntax
public enum ConnectionStopReason
Remarks

Disconnected is announced from every ending a connection can have, and they call for different reactions: a consumer's own disconnect is not a failure, a spent reconnect budget is a reason to try another server, and a broken OnConnected handler is a reason to fix the handler rather than move away from a node that is answering. Until now they differed only in the text of the message.

It lives here rather than in ReconnectInfo on purpose: filling that in on a terminal notification would give Reconnect != null a second meaning, when consumers read it as "a reconnect is in progress".

Fields

Name Description
ClosedPermanently

The connection was closed for good, with no reconnect to follow.
ConnectHandlerFailed

The client gave up because its OnConnected handler kept failing.
None

The notification is not a terminal one.
ReconnectExhausted

The reconnect loop spent its budget of attempts and stopped.
UserDisconnected

The consumer called Disconnect() or DisconnectAndWaitAsync().

Extension Methods