Class Connection

Inheritance

object

Connection

Namespace: Xrpl.Client

Assembly: Xrpl.dll

Syntax

public class Connection

Constructors

| Edit this page View Source

Connection(string, ConnectionOptions?)

Declaration

public Connection(string server, Connection.ConnectionOptions? options = null)

Parameters

Type	Name	Description
string	server
Connection.ConnectionOptions	options

Fields

| Edit this page View Source

connectionManager

Declaration

public ConnectionManager connectionManager

Field Value

Type	Description
ConnectionManager

| Edit this page View Source

requestManager

Declaration

public RequestManager requestManager

Field Value

Type	Description
RequestManager

| Edit this page View Source

timer

Declaration

public Timer timer

Field Value

Type	Description
Timer

| Edit this page View Source

ws

Declaration

public WebSocketClient ws

Field Value

Type	Description
WebSocketClient

Properties

| Edit this page View Source

CurrentConnectionState

Declaration

public XrpConnectionState CurrentConnectionState { get; }

Property Value

Type	Description
XrpConnectionState

| Edit this page View Source

config

Declaration

public Connection.ConnectionOptions config { get; }

Property Value

Type	Description
Connection.ConnectionOptions

| Edit this page View Source

url

Declaration

public string url { get; }

Property Value

Type	Description
string

Methods

| Edit this page View Source

Base64Decode(string)

Declaration

public static string Base64Decode(string base64EncodedData)

Parameters

Type	Name	Description
string	base64EncodedData

Returns

Type	Description
string

| Edit this page View Source

Base64Encode(string)

Declaration

public static string Base64Encode(string plainText)

Parameters

Type	Name	Description
string	plainText

Returns

Type	Description
string

| Edit this page View Source

ChangeServer(string, ConnectionOptions?, CancellationToken)

Declaration

public Task ChangeServer(string server, Connection.ConnectionOptions? options = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	server
Connection.ConnectionOptions	options
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Edit this page View Source

Connect(CancellationToken)

Declaration

public Task Connect(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Edit this page View Source

Disconnect()

Declaration

public Task<int> Disconnect()

Returns

Type	Description
Task<int>

| Edit this page View Source

DisconnectAndWaitAsync(TimeSpan, CancellationToken)

Disconnects and waits for the WebSocket to be fully closed and cleaned up.

Declaration

public Task DisconnectAndWaitAsync(TimeSpan timeout, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TimeSpan	timeout	Maximum time to wait for cleanup.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task

| Edit this page View Source

GRequest<T, R>(R, TimeSpan?, RequestFailurePolicy?, CancellationToken)

Declaration

public Task<object> GRequest<T, R>(R request, TimeSpan? timeout = null, RequestFailurePolicy? policyOverride = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
R	request
TimeSpan?	timeout
RequestFailurePolicy?	policyOverride
CancellationToken	cancellationToken

Returns

Type	Description
Task<object>

Type Parameters

Name	Description
T
R

| Edit this page View Source

GetUrl()

Declaration

public string GetUrl()

Returns

Type	Description
string

| Edit this page View Source

HasConnectionAsync(TimeSpan?)

Declaration

public Task<bool> HasConnectionAsync(TimeSpan? timeout = null)

Parameters

Type	Name	Description
TimeSpan?	timeout

Returns

Type	Description
Task<bool>

| Edit this page View Source

IsConnected()

Declaration

public bool IsConnected()

Returns

Type	Description
bool

| Edit this page View Source

OnMessage(string)

Declaration

public Task OnMessage(string message)

Parameters

Type	Name	Description
string	message

Returns

Type	Description
Task

| Edit this page View Source

Request(Dictionary<string, object>, TimeSpan?, RequestFailurePolicy?, CancellationToken)

Declaration

public Task<Dictionary<string, object>> Request(Dictionary<string, object> request, TimeSpan? timeout = null, RequestFailurePolicy? policyOverride = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Dictionary<string, object>	request
TimeSpan?	timeout
RequestFailurePolicy?	policyOverride
CancellationToken	cancellationToken

Returns

Type	Description
Task<Dictionary<string, object>>

| Edit this page View Source

State()

Declaration

public WebSocketState State()

Returns

Type	Description
WebSocketState

| Edit this page View Source

WaitForConnectionAsync(TimeSpan?, CancellationToken)

Declaration

public Task WaitForConnectionAsync(TimeSpan? timeout = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
TimeSpan?	timeout
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Edit this page View Source

WebsocketSendAsync(WebSocketClient, string)

Sends a message through the WebSocket connection.

Declaration

public void WebsocketSendAsync(WebSocketClient ws, string message)

Parameters

Type	Name	Description
WebSocketClient	ws	The WebSocket client to send through.
string	message	The message to send.

Exceptions

Type	Condition
DisconnectedException	Thrown when the WebSocket connection is null or closed.

Events

| Edit this page View Source

OnConnected

Declaration

public event OnConnected OnConnected

Event Type

Type	Description
OnConnected

| Edit this page View Source

OnConnectionStatus

Declaration

public event Action<ConnectionStatusInfo> OnConnectionStatus

Event Type

Type	Description
Action<ConnectionStatusInfo>

| Edit this page View Source

OnConsensusPhase

Declaration

public event OnConsensusPhase OnConsensusPhase

Event Type

Type	Description
OnConsensusPhase

| Edit this page View Source

OnDisconnect

Declaration

public event OnDisconnect OnDisconnect

Event Type

Type	Description
OnDisconnect

| Edit this page View Source

OnError

Declaration

public event OnError OnError

Event Type

Type	Description
OnError

| Edit this page View Source

OnLedgerClosed

Declaration

public event OnLedgerClosed OnLedgerClosed

Event Type

Type	Description
OnLedgerClosed

| Edit this page View Source

OnManifestReceived

Declaration

public event OnManifestReceived OnManifestReceived

Event Type

Type	Description
OnManifestReceived

| Edit this page View Source

OnPathFind

Declaration

public event OnPathFind OnPathFind

Event Type

Type	Description
OnPathFind

| Edit this page View Source

OnPeerStatusChange

Declaration

public event OnPeerStatusChange OnPeerStatusChange

Event Type

Type	Description
OnPeerStatusChange

| Edit this page View Source

OnPing

Declaration

public event OnPing OnPing

Event Type

Type	Description
OnPing

| Edit this page View Source

OnServerWarning

Declaration

public event OnServerWarning OnServerWarning

Event Type

Type	Description
OnServerWarning

| Edit this page View Source

OnTransaction

Declaration

public event OnTransaction OnTransaction

Event Type

Type	Description
OnTransaction

| Edit this page View Source

OnWarning

Declaration

public event OnWarning OnWarning

Event Type

Type	Description
OnWarning