Package org.apache.camel.util.backoff

Interface BackOffTimer

All Known Implementing Classes:

SimpleBackOffTimer

public interface BackOffTimer

A simple timer utility that use a linked BackOff to determine when a task should be executed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BackOffTimer.Task

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets the name of this timer.
Set<BackOffTimer.Task>	getTasks()	Access to unmodifiable set of all the tasks
void	remove(BackOffTimer.Task task)	Removes the task
BackOffTimer.Task	schedule(BackOff backOff, ThrowingFunction<BackOffTimer.Task,Boolean,Exception> function)	Schedules a task to run according to the backoff settings
int	size()	Number of tasks

Method Details

schedule

BackOffTimer.Task schedule(BackOff backOff,
 ThrowingFunction<BackOffTimer.Task,Boolean,Exception> function)

Schedules a task to run according to the backoff settings

Parameters:

backOff - the settings for how often to run the task

function - the function to call for each run

Returns:

the task

getName

String getName()

Gets the name of this timer.

remove

void remove(BackOffTimer.Task task)

Removes the task

getTasks

Set<BackOffTimer.Task> getTasks()

Access to unmodifiable set of all the tasks

size

int size()

Number of tasks