io.apiman.gateway.engine.components

Interface IPeriodicComponent

public interface IPeriodicComponent

Simple timers, either periodic (setPeriodicTimer(long, long, IAsyncHandler)) or one-off setOneshotTimer(long, IAsyncHandler). They can be cancelled using the returned id (via method call or handler). Cancellations must be idempotent.

Author:

Marc Savy

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAll() Cancel all timers.
void	cancelTimer(long timerId) Cancel a timer using its ID.
long	setOneshotTimer(long deltaMillis, IAsyncHandler<Long> timerHandler) Calls handler only once after the specified long deltaMillis milliseconds has elapsed.
long	setPeriodicTimer(long periodMillis, long initialDelayMillis, IAsyncHandler<Long> periodicHandler) Calls handler every periodMillis milliseconds after waiting initialDelayMillis for the first iteration.

Method Detail

setPeriodicTimer

long setPeriodicTimer(long periodMillis,
                    long initialDelayMillis,
                    IAsyncHandler<Long> periodicHandler)

Calls handler every periodMillis milliseconds after waiting initialDelayMillis for the first iteration.

Parameters:

periodMillis - periodic frequency to call handler in delta milliseconds

initialDelayMillis - delta milliseconds to call handler for first iteration

periodicHandler - handler with unique timer ID

Returns:

timer ID

setOneshotTimer

long setOneshotTimer(long deltaMillis,
                   IAsyncHandler<Long> timerHandler)

Calls handler only once after the specified long deltaMillis milliseconds has elapsed.

Parameters:

deltaMillis - delta milliseconds

timerHandler - handler with unique timer ID

Returns:

timer ID

cancelTimer

void cancelTimer(long timerId)

Cancel a timer using its ID. This deschedules any executions pending for that ID, including those that have yet to run. Operation is idempotent.

Parameters:

timerId - Unique ID of timer to be cancelled

cancelAll

void cancelAll()

Cancel all timers.