Class WebSocketClient

Namespace

NetCord.Gateway

Assembly

NetCord.dll

public abstract class WebSocketClient : IDisposable

Inheritance

object

WebSocketClient

Implements

IDisposable

Derived

GatewayClient

VoiceClient

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Latency

The latency of the WebSocketClient.

public TimeSpan Latency { get; }

Property Value

TimeSpan

Status

The status of the WebSocketClient.

public WebSocketStatus Status { get; }

Property Value

WebSocketStatus

Methods

Abort()

public void Abort()

CloseAsync(WebSocketCloseStatus, string?, CancellationToken)

Closes the WebSocketClient.

public ValueTask CloseAsync(WebSocketCloseStatus status = WebSocketCloseStatus.NormalClosure, string? statusDescription = null, CancellationToken cancellationToken = default)

Parameters

status WebSocketCloseStatus

The status to close with.

statusDescription string

The status description to close with.

cancellationToken CancellationToken

The cancellation token.

Returns

ValueTask

Dispose()

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

SendPayloadAsync(ReadOnlyMemory<byte>, WebSocketPayloadProperties?, CancellationToken)

public ValueTask SendPayloadAsync(ReadOnlyMemory<byte> buffer, WebSocketPayloadProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

buffer ReadOnlyMemory<byte>

properties WebSocketPayloadProperties

cancellationToken CancellationToken

Returns

ValueTask

Events

Close

public event Func<ValueTask>? Close

Event Type

Func<ValueTask>

Connect

public event Func<ValueTask>? Connect

Event Type

Func<ValueTask>

Connecting

public event Func<ValueTask>? Connecting

Event Type

Func<ValueTask>

Disconnect

public event Func<DisconnectEventArgs, ValueTask>? Disconnect

Event Type

Func<DisconnectEventArgs, ValueTask>

LatencyUpdate

public event Func<TimeSpan, ValueTask>? LatencyUpdate

Event Type

Func<TimeSpan, ValueTask>

Resume

public event Func<ValueTask>? Resume

Event Type

Func<ValueTask>