discord4j.gateway

Class DiscordWebSocketHandler

java.lang.Object

discord4j.gateway.DiscordWebSocketHandler

public class DiscordWebSocketHandler
extends Object

Represents a WebSocket handler specialized for Discord gateway operations.

Includes a zlib-based decompressor and dedicated handling of closing events that normally occur during Discord gateway lifecycle.

This handler uses a FluxSink of ByteBuf to push inbound payloads and a Flux of ByteBuf to pull outbound payloads.

The handler also provides two methods to control the lifecycle and proper cleanup, like close() and error(Throwable) which perform operations on the current session. It is necessary to use these methods in order to signal closure or errors and cleanly complete the session.

Constructor Summary

Constructors

Constructor and Description
DiscordWebSocketHandler(FluxSink<ByteBuf> inbound, Flux<ByteBuf> outbound, MonoProcessor<CloseStatus> closeTrigger, int shardIndex) Create a new handler with the given data pipelines.

Method Summary

Modifier and Type	Method and Description
void	close() Initiates a close sequence that will terminate this session.
void	error(Throwable error) Initiates a close sequence with the given error.
Mono<Void>	handle(WebsocketInbound in, WebsocketOutbound out)

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscordWebSocketHandler

public DiscordWebSocketHandler(FluxSink<ByteBuf> inbound,
                               Flux<ByteBuf> outbound,
                               MonoProcessor<CloseStatus> closeTrigger,
                               int shardIndex)

Create a new handler with the given data pipelines.

Parameters:

inbound - the FluxSink of ByteBuf to process inbound payloads

outbound - the Flux of ByteBuf to process outbound payloads

closeTrigger - a MonoProcessor that triggers the closing of this session

shardIndex - the shard index of this connection, for tracing

Method Detail

handle

public Mono<Void> handle(WebsocketInbound in,
                         WebsocketOutbound out)

close

public void close()

Initiates a close sequence that will terminate this session. It will notify all exchanges and the session completion Mono in handle(reactor.netty.http.websocket.WebsocketInbound, reactor.netty.http.websocket.WebsocketOutbound) through a complete signal, dropping all future signals.

error

public void error(Throwable error)

Initiates a close sequence with the given error. It will terminate this session with an error signal on the handle(reactor.netty.http.websocket.WebsocketInbound, reactor.netty.http.websocket.WebsocketOutbound) method, while completing both exchanges through normal complete signals.

The error can then be channeled downstream and acted upon accordingly.

Parameters:

error - the cause for this session termination