Package discord4j.gateway

Class GatewayWebsocketHandler

java.lang.Object

discord4j.gateway.GatewayWebsocketHandler

public class GatewayWebsocketHandler
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 methods to control the lifecycle, which perform operations on the current session. It is required to use them to properly release important resources and complete the session.

Constructor Summary

Constructors

Constructor	Description
GatewayWebsocketHandler(Sinks.Many<ByteBuf> inbound, Flux<ByteBuf> outbound, ContextView context)	Create a new handler with the given data pipelines.
GatewayWebsocketHandler(Sinks.Many<ByteBuf> inbound, Flux<ByteBuf> outbound, ContextView context, boolean unpooled)

Method Summary

Modifier and Type	Method	Description
void	close()	Initiates a close sequence that will terminate this session and instruct consumers downstream that a reconnect should take place afterwards.
void	close(DisconnectBehavior behavior)	Initiates a close sequence that will terminate this session and then execute a given DisconnectBehavior.
void	error(Throwable error)	Initiates a close sequence with the given error.
Mono<Tuple2<DisconnectBehavior,CloseStatus>>	handle(WebsocketInbound in, WebsocketOutbound out)	Handle an upgraded websocket connection, given by both WebsocketInbound and WebsocketOutbound to manage a session until the remote closes or one of the local methods close() or error(Throwable) methods are called.

Methods inherited from class java.lang.Object

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

Constructor Details

GatewayWebsocketHandler

public GatewayWebsocketHandler(Sinks.Many<ByteBuf> inbound,
 Flux<ByteBuf> outbound,
 ContextView context)

Create a new handler with the given data pipelines.

Parameters:

inbound - the Sinks.Many of ByteBuf to process inbound payloads

outbound - the Flux of ByteBuf to process outbound payloads

context - the Reactor ContextView that owns this handler, to enrich logging

GatewayWebsocketHandler

public GatewayWebsocketHandler(Sinks.Many<ByteBuf> inbound,
 Flux<ByteBuf> outbound,
 ContextView context,
 boolean unpooled)

Method Details

handle

public Mono<Tuple2<DisconnectBehavior,CloseStatus>> handle(WebsocketInbound in,
 WebsocketOutbound out)

Handle an upgraded websocket connection, given by both WebsocketInbound and WebsocketOutbound to manage a session until the remote closes or one of the local methods close() or error(Throwable) methods are called. When that happens, a close procedure will take place and ultimately emit a pair of DisconnectBehavior and remote CloseStatus, if present or "-1" if none is present.

Parameters:

in - the websocket inbound

out - the websocket outbound

Returns:

a Mono that upon subscription, manages a websocket session until it closes where a Tuple2 is emitted representing both the DisconnectBehavior that initiated the close procedure, and the inbound CloseStatus.

close

public void close()

Initiates a close sequence that will terminate this session and instruct consumers downstream that a reconnect should take place afterwards.

close

public void close(DisconnectBehavior behavior)

Initiates a close sequence that will terminate this session and then execute a given DisconnectBehavior.

Parameters:

behavior - the DisconnectBehavior to follow after the close sequence starts

error

public void error(Throwable error)

Initiates a close sequence with the given error. The session will be terminated abruptly and then instruct consumers downstream that a reconnect should take place afterwards.

Parameters:

error - the cause for this session termination