Package net.dv8tion.jda.core.events

Class DisconnectEvent

java.lang.Object

net.dv8tion.jda.core.events.Event

net.dv8tion.jda.core.events.DisconnectEvent

public class DisconnectEvent
extends Event

Indicates that JDA has been disconnected from the remote server.
When this event is fired JDA will try to reconnect if possible unless JDABuilder.setAutoReconnect(Boolean) has been provided false or the disconnect was too fatal.

When reconnecting was successful either a ReconnectEvent or a ResumedEvent is fired.

Constructor Summary

Constructors

Constructor	Description
DisconnectEvent(JDA api, com.neovisionaries.ws.client.WebSocketFrame serverCloseFrame, com.neovisionaries.ws.client.WebSocketFrame clientCloseFrame, boolean closedByServer, java.time.OffsetDateTime disconnectTime)

Method Summary

Modifier and Type	Method	Description
com.neovisionaries.ws.client.WebSocketFrame	getClientCloseFrame()	The close frame we sent to discord
CloseCode	getCloseCode()	Possibly-null CloseCode representing the meaning for this DisconnectEvent
java.util.List<java.lang.String>	getCloudflareRays()	Contains all cf-ray headers that JDA received in this session.
java.time.OffsetDateTime	getDisconnectTime()	Time at which we noticed the disconnection
com.neovisionaries.ws.client.WebSocketFrame	getServiceCloseFrame()	The close frame discord sent to us
boolean	isClosedByServer()	Whether the connection was closed by discord

Methods inherited from class net.dv8tion.jda.core.events.Event

getJDA, getResponseNumber

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DisconnectEvent

public DisconnectEvent(JDA api,
                       com.neovisionaries.ws.client.WebSocketFrame serverCloseFrame,
                       com.neovisionaries.ws.client.WebSocketFrame clientCloseFrame,
                       boolean closedByServer,
                       java.time.OffsetDateTime disconnectTime)

Method Detail

getCloseCode

public CloseCode getCloseCode()

Possibly-null CloseCode representing the meaning for this DisconnectEvent

This is null if this disconnect did either not happen because the Service closed the session (see isClosedByServer()) or if there is no mapped CloseCode enum constant for the service close code!

Returns:

Possibly-null CloseCode

getCloudflareRays

public java.util.List<java.lang.String> getCloudflareRays()

Contains all cf-ray headers that JDA received in this session.
These receive a new value whenever the WebSockedClient reconnects to the gateway.

This is useful to monitor cloudflare activity from the Discord Developer perspective.
Use this list to report connection issues.

Returns:

Immutable list of all cf-ray values for this session

getServiceCloseFrame

public com.neovisionaries.ws.client.WebSocketFrame getServiceCloseFrame()

The close frame discord sent to us

Returns:

The WebSocketFrame discord sent as closing handshake

getClientCloseFrame

public com.neovisionaries.ws.client.WebSocketFrame getClientCloseFrame()

The close frame we sent to discord

Returns:

The WebSocketFrame we sent as closing handshake

isClosedByServer

public boolean isClosedByServer()

Whether the connection was closed by discord

Returns:

True, if discord closed our connection

getDisconnectTime

public java.time.OffsetDateTime getDisconnectTime()

Time at which we noticed the disconnection

Returns:

Time of closure