discord4j.common.retry

Class ReconnectOptions

java.lang.Object

discord4j.common.retry.ReconnectOptions

public class ReconnectOptions
extends Object

A configuration object to customize the gateway reconnection policy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReconnectOptions.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReconnectOptions(ReconnectOptions.Builder builder)

Method Summary

Modifier and Type	Method and Description
static ReconnectOptions.Builder	builder()
static ReconnectOptions	create()
Backoff	getBackoff() Retrieve the backoff function used for retrying.
Scheduler	getBackoffScheduler() Returns a scheduler provided every reconnect attempt, as backoff delay.
Duration	getFirstBackoff()
Jitter	getJitter() Retrieve the jitter to be applied on each backoff delay.
Duration	getMaxBackoffInterval()
int	getMaxRetries() Returns the number of retries.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReconnectOptions

protected ReconnectOptions(ReconnectOptions.Builder builder)

Method Detail

create

public static ReconnectOptions create()

builder

public static ReconnectOptions.Builder builder()

getFirstBackoff

public Duration getFirstBackoff()

getMaxBackoffInterval

public Duration getMaxBackoffInterval()

getMaxRetries

public int getMaxRetries()

Returns the number of retries.

Returns:

number of retries

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

getBackoffScheduler

public Scheduler getBackoffScheduler()

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

Returns:

scheduler used when reconnecting