org.neo4j.causalclustering.core.consensus.schedule

Interface RenewableTimeoutService.RenewableTimeout

Enclosing interface:

RenewableTimeoutService

public static interface RenewableTimeoutService.RenewableTimeout

The handle for a timeout. This represents the timeout for calling a RenewableTimeoutService.TimeoutHandler, as it is returned from a call to RenewableTimeoutService.create(TimeoutName, long, long, TimeoutHandler).

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels this timeout.
void	renew() Renews the timeout for the handler represented by this instance.

Method Detail

renew

void renew()

Renews the timeout for the handler represented by this instance. The effect of calling this method is that upon return, the handler will be called in an interval equal to that provided to the RenewableTimeoutService.create(TimeoutName, long, long, TimeoutHandler) on creation.
This timeout renewal effect takes place regardless of whether the handler has been called or not or if it has been cancelled.

cancel

void cancel()

Cancels this timeout. If the handler has not been called, it will not be called when the delay specified on creation elapses. Calling renew() will reset the delay and the handler will eventually be called.