org.neo4j.causalclustering.core.consensus.schedule

Class DelayedRenewableTimeoutService

java.lang.Object

org.neo4j.kernel.lifecycle.LifecycleAdapter

org.neo4j.causalclustering.core.consensus.schedule.DelayedRenewableTimeoutService

All Implemented Interfaces:

Runnable, RenewableTimeoutService, org.neo4j.kernel.lifecycle.Lifecycle

public class DelayedRenewableTimeoutService
extends org.neo4j.kernel.lifecycle.LifecycleAdapter
implements Runnable, RenewableTimeoutService

A bare bones, wall clock based implementation of the RenewableTimeoutService. It uses a scheduled thread pool to check for timeouts and as such has a limited resolution of TIMER_RESOLUTION, measured in TIMER_RESOLUTION_UNIT. For the same reason, the timeouts are triggered at an approximate delay rather than exactly at the value requested. RenewableTimeoutService.TimeoutHandler are all called from the same thread, so users should be aware to not perform time consuming tasks in them.

Nested Class Summary

Nested classes/interfaces inherited from interface org.neo4j.causalclustering.core.consensus.schedule.RenewableTimeoutService

RenewableTimeoutService.RenewableTimeout, RenewableTimeoutService.TimeoutHandler, RenewableTimeoutService.TimeoutName

Nested classes/interfaces inherited from interface org.neo4j.kernel.lifecycle.Lifecycle

org.neo4j.kernel.lifecycle.Lifecycle.Delegate

Constructor Summary

Constructors

Constructor and Description
DelayedRenewableTimeoutService(Clock clock, org.neo4j.logging.LogProvider logProvider)

Method Summary

Modifier and Type	Method and Description
RenewableTimeoutService.RenewableTimeout	create(RenewableTimeoutService.TimeoutName name, long delayInMillis, long randomRangeInMillis, RenewableTimeoutService.TimeoutHandler handler) Set up a new timeout.
void	init()
void	run()
void	start()
void	stop()

Methods inherited from class org.neo4j.kernel.lifecycle.LifecycleAdapter

shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

DelayedRenewableTimeoutService

public DelayedRenewableTimeoutService(Clock clock,
                                      org.neo4j.logging.LogProvider logProvider)

Method Detail

create

public RenewableTimeoutService.RenewableTimeout create(RenewableTimeoutService.TimeoutName name,
                                                       long delayInMillis,
                                                       long randomRangeInMillis,
                                                       RenewableTimeoutService.TimeoutHandler handler)

Set up a new timeout.

The randomRangeInMillis attribute allows you to introduce a bit of arbitrariness in when the timeout is triggered, which is a useful way to avoid "thundering herds" when multiple timeouts are likely to trigger at the same time.

If you don't want randomness, set randomRangeInMillis to 0.

Specified by:

create in interface RenewableTimeoutService

Parameters:

name - The timeout name, for lookup purposes

delayInMillis - The amount of time after this timeout will be triggered

randomRangeInMillis - The upper limit of a range of longs (0 is the lower limit) from which a random value will be selected with uniform probability, and added to the delay. Setting this value to 0 means no randomness.

handler - The RenewableTimeoutService.TimeoutHandler to call when this timeout triggers

Returns:

The timeout handle

run

public void run()

Specified by:

run in interface Runnable

init

public void init()

Specified by:

init in interface org.neo4j.kernel.lifecycle.Lifecycle

Overrides:

init in class org.neo4j.kernel.lifecycle.LifecycleAdapter

start

public void start()

Specified by:

start in interface org.neo4j.kernel.lifecycle.Lifecycle

Overrides:

start in class org.neo4j.kernel.lifecycle.LifecycleAdapter

stop

public void stop()

Specified by:

stop in interface org.neo4j.kernel.lifecycle.Lifecycle

Overrides:

stop in class org.neo4j.kernel.lifecycle.LifecycleAdapter