com.couchbase.client.core.env

Class TimerConfig.Builder

java.lang.Object

com.couchbase.client.core.env.TimerConfig.Builder

Enclosing class:

TimerConfig

public static class TimerConfig.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TimerConfig	build()
TimerConfig.Builder	numBuckets(int numBuckets) Internally, each Timer divides time into a number of buckets, which this setting controls.
TimerConfig.Builder	numTimers(int numTimers) Configures multiple parallel Timers, allowing more throughput of retries and timeouts.
TimerConfig.Builder	tickDuration(Duration tickDuration) Configures the time between each 'tick' of the Timer(s).

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

numTimers

@Stability.Volatile
public TimerConfig.Builder numTimers(int numTimers)

Configures multiple parallel Timers, allowing more throughput of retries and timeouts.

It defaults to 1.

tickDuration

@Stability.Volatile
public TimerConfig.Builder tickDuration(Duration tickDuration)

Configures the time between each 'tick' of the Timer(s).

Timeouts and retries can only fire as accurately as this resolution. If reducing the value, users may want to increase the numBuckets(int) setting.

It defaults to 10 milliseconds.

numBuckets

@Stability.Volatile
public TimerConfig.Builder numBuckets(int numBuckets)

Internally, each Timer divides time into a number of buckets, which this setting controls.

It defaults to 512.

If it's expected that many timeouts or retries will be firing, users may want to increase this setting.

build

public TimerConfig build()