org.neo4j.causalclustering.core.consensus.schedule

Interface RenewableTimeoutService

All Known Implementing Classes:

DelayedRenewableTimeoutService

public interface RenewableTimeoutService

A service for creating RenewableTimeoutService.RenewableTimeout instances. Implementations of this interface are expected but not required to also act as lifecycle managers for the timeouts they return.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RenewableTimeoutService.RenewableTimeout The handle for a timeout.
static interface	RenewableTimeoutService.TimeoutHandler Represents the action to take upon expiry of a timeout.
static interface	RenewableTimeoutService.TimeoutName

Method Summary

Modifier and Type	Method and Description
RenewableTimeoutService.RenewableTimeout	create(RenewableTimeoutService.TimeoutName timeoutName, long delayInMillis, long randomRangeInMillis, RenewableTimeoutService.TimeoutHandler handler) The main factory method.

Method Detail

create

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

The main factory method. Returns a RenewableTimeoutService.RenewableTimeout handle for a RenewableTimeoutService.TimeoutHandler that will trigger once, after plus or minus a random interval, unless renewed. Upon triggering, the supplied will be called.
The time delay is a best effort service. In essence, the delay should not be expected to be accurate to the millisecond, as thread scheduling and other factors may influence when the handler is actually called.

Parameters:

timeoutName - 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