discord4j.gateway

Class DefaultGatewayClientFactory

java.lang.Object

discord4j.gateway.DefaultGatewayClientFactory

All Implemented Interfaces:

GatewayClientFactory

public class DefaultGatewayClientFactory
extends Object
implements GatewayClientFactory

Default factory to create GatewayClient objects based on DefaultGatewayClient that connects using a single shard per client, forwarding events through GatewayPayload objects.

Constructor Summary

Constructors

Constructor and Description
DefaultGatewayClientFactory()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGatewayClientFactory

public DefaultGatewayClientFactory()

Method Detail

getGatewayClient

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

Description copied from interface: GatewayClientFactory

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

Specified by:

getGatewayClient in interface GatewayClientFactory

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