Class WebSocketClosedEventArgs

Namespace

Nyra.EventArgs

Assembly

Nyra.dll

Raised when the Discord voice websocket of the player was closed.

public sealed class WebSocketClosedEventArgs : EventArgs

Inheritance

object

EventArgs

WebSocketClosedEventArgs

Inherited Members

EventArgs.Empty

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

For NodeLink this also reports synthetic voice deaths (worker failure, UDP/IP-discovery loss) that never closed a Discord websocket (see Code). It also emits deaths that never came from Discord wearing Discord codes, for example 4015 when its voice library gives up reconnecting and 4014 when the voice server endpoint is null. Do not attribute 4xxx to Discord on NodeLink without checking the reason.

Properties

ByRemote

Whether the websocket was closed by Discord.

[JsonPropertyName("byRemote")]
[JsonInclude]
public bool ByRemote { get; }

Property Value

bool

Remarks

NodeLink reports true for every synthetic voice death as well, its voice library sets it unconditionally, so true does not imply a Discord-initiated close outside Lavalink.

Code

Discord voice close event code, the 4xxx family signals failures.

[JsonPropertyName("code")]
[JsonInclude]
public int? Code { get; }

Property Value

int?

Remarks

NodeLink also emits synthetic non-Discord codes, 1000 on client destroy, 5001 on cluster worker failure, and null on voice failures that carry no close code at all (UDP loss, IP discovery failure), those deaths never opened a close handshake, there is no code to report.

GuildId

The guild the player plays in.

[JsonPropertyName("guildId")]
[JsonInclude]
[JsonConverter(typeof(TolerantSnowflakeConverter))]
public ulong GuildId { get; }

Property Value

ulong

Reason

Why the voice websocket closed.

[JsonPropertyName("reason")]
[JsonInclude]
public string Reason { get; }

Property Value

string

Remarks

Absorbs a null reason the server sends, readers see an empty string instead of null. Defensive only, no current server sends one, NodeLink's no-close deaths carry the library's own reason string, see Code for the discriminator.