discord4j.gateway.retry

Class RetryOptions

java.lang.Object

discord4j.gateway.retry.RetryOptions

public class RetryOptions
extends Object

A configuration object to customize the gateway retry (reconnecting) policy. Tracks reconnection state for a single connection, therefore instances are not shareable across multiple GatewayClients.

Constructor Summary

Constructors

Constructor and Description
RetryOptions(Duration firstBackoff, Duration maxBackoffInterval, int maxRetries, Scheduler scheduler) Create a retry configuration object.

Method Summary

Modifier and Type	Method and Description
Backoff	getBackoff() Retrieve the backoff function used for retrying.
Scheduler	getBackoffScheduler() Returns a scheduler provided every reconnect attempt, as backoff delay.
Jitter	getJitter() Retrieve the jitter to be applied on each backoff delay.
int	getMaxRetries() Returns the number of retries.
RetryContext	getRetryContext() Retrieve a stateful context object to hold current attempt count and backoff delay on each retry.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryOptions

public RetryOptions(Duration firstBackoff,
                    Duration maxBackoffInterval,
                    int maxRetries,
                    Scheduler scheduler)

Create a retry configuration object.

Parameters:

firstBackoff - the Duration to backoff on first attempts

maxBackoffInterval - the maximum backoff Duration

maxRetries - the maximum amount of retries to attempt a reconnect

scheduler - the backoff scheduler used for reconnect delays

Method Detail

getRetryContext

public RetryContext getRetryContext()

Retrieve a stateful context object to hold current attempt count and backoff delay on each retry.

Returns:

the RetryContext associated with this configuration object

getBackoff

public Backoff getBackoff()

Retrieve the backoff function used for retrying. It uses a RetryContext object to calculate the correct backoff delay.

Returns:

a Backoff function

getJitter

public Jitter getJitter()

Retrieve the jitter to be applied on each backoff delay.

Returns:

a Jitter function

getMaxRetries

public int getMaxRetries()

Returns the number of retries.

Returns:

number of retries

getBackoffScheduler

public Scheduler getBackoffScheduler()

Returns a scheduler provided every reconnect attempt, as backoff delay.

Returns:

scheduler used when reconnecting