discord4j.gateway

Interface GatewayClientFactory

All Known Implementing Classes:

DefaultGatewayClientFactory

public interface GatewayClientFactory

An abstract factory to create a GatewayClient, allowing clients to send and receive Discord Gateway events from this node.

Method Summary

Modifier and Type	Method and Description
GatewayClient	getGatewayClient(HttpClient httpClient, PayloadReader payloadReader, PayloadWriter payloadWriter, RetryOptions retryOptions, String token, IdentifyOptions identifyOptions, GatewayObserver observer, PayloadTransformer identifyLimiter) Create GatewayClient objects, supporting real-time events from Discord.

Method Detail

getGatewayClient

GatewayClient getGatewayClient(HttpClient httpClient,
                               PayloadReader payloadReader,
                               PayloadWriter payloadWriter,
                               RetryOptions retryOptions,
                               String token,
                               IdentifyOptions identifyOptions,
                               GatewayObserver observer,
                               PayloadTransformer identifyLimiter)

Create GatewayClient objects, supporting real-time events from Discord.

Parameters:

httpClient - a Reactor Netty HttpClient to use in the created client

payloadReader - a deserialization strategy to received payloads

payloadWriter - a serialization strategy to sent payloads

retryOptions - a configurable reconnection policy

token - an authorization token to log into Discord Gateway

identifyOptions - a configurable set of shard and presence parameters

observer - a hook that listens to many gateway lifecycle events

identifyLimiter - a rate-limiting policy to coordinate identify requests

Returns:

a client allowing communication with Discord Gateway