Package 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	Description
static class	ReconnectOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final Supplier<Scheduler>	DEFAULT_BACKOFF_SCHEDULER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReconnectOptions(ReconnectOptions.Builder builder)

Method Summary

Modifier and Type	Method	Description
static ReconnectOptions.Builder	builder()	Create a new builder for ReconnectOptions.
static ReconnectOptions	create()	Create a default ReconnectOptions.
Backoff	getBackoff()	Deprecated. only select implementations will use this value.
Scheduler	getBackoffScheduler()	Returns a scheduler provided every reconnect attempt, as backoff delay.
Duration	getFirstBackoff()	Return the minimum backoff duration.
Jitter	getJitter()	Deprecated. only select implementations will use this value.
double	getJitterFactor()	Retrieve the jitter factor to be applied on each backoff delay.
Duration	getMaxBackoffInterval()	Return the maximum backoff duration.
long	getMaxRetries()	Returns the number of retries.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BACKOFF_SCHEDULER

public static final Supplier<Scheduler> DEFAULT_BACKOFF_SCHEDULER

Constructor Details

ReconnectOptions

protected ReconnectOptions(ReconnectOptions.Builder builder)

Method Details

create

public static ReconnectOptions create()

Create a default ReconnectOptions.

Returns:

a new reconnect options configured with all defaults

builder

public static ReconnectOptions.Builder builder()

Create a new builder for ReconnectOptions.

Returns:

a new builder

getFirstBackoff

public Duration getFirstBackoff()

Return the minimum backoff duration.

Returns:

minimum backoff duration

getMaxBackoffInterval

public Duration getMaxBackoffInterval()

Return the maximum backoff duration.

Returns:

maximum backoff duration

getMaxRetries

public long getMaxRetries()

Returns the number of retries.

Returns:

number of retries

getBackoff

@Deprecated
public Backoff getBackoff()

Deprecated.

only select implementations will use this value. Moving forward, consider assuming an exponential backoff function bounded by getFirstBackoff() and getMaxBackoffInterval()

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

Returns:

a Backoff function

getJitter

@Deprecated
public Jitter getJitter()

Deprecated.

only select implementations will use this value. Moving forward, consider also using getJitterFactor()

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

getJitterFactor

public double getJitterFactor()

Retrieve the jitter factor to be applied on each backoff delay.

Returns:

a jitter factor value between 0d and 1d