Class ConnectionStatusInfo

Inheritance

object

ConnectionStatusInfo

Namespace: Xrpl.Client

Assembly: Xrpl.dll

Syntax

public class ConnectionStatusInfo

Properties

ConnectionState

Declaration

public XrpConnectionState ConnectionState { get; set; }

Property Value

Type	Description
XrpConnectionState

Message

Declaration

public string Message { get; set; }

Property Value

Type	Description
string

Reconnect

Declaration

public ReconnectInfo? Reconnect { get; set; }

Property Value

Type	Description
ReconnectInfo

Severity

Declaration

public ConnectionCloseSeverity Severity { get; set; }

Property Value

Type	Description
ConnectionCloseSeverity

StopReason

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

Declaration

public ConnectionStopReason StopReason { get; set; }

Property Value

Type	Description
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".