Package org.apache.camel.util.backoff

Interface BackOffTimer.Task

All Known Implementing Classes:

BackOffTimerTask

Enclosing interface:

BackOffTimer

public static interface BackOffTimer.Task

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BackOffTimer.Task.Status

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancel the task.
BackOff	getBackOff()	The back-off associated with this task.
long	getCurrentAttempts()	The number of attempts so far.
long	getCurrentDelay()	The current computed delay.
long	getCurrentElapsedTime()	The current elapsed time.
Throwable	getException()	The task failed for some un-expected exception
long	getFirstAttemptTime()	The time the first attempt was performed.
long	getLastAttemptTime()	The time the last attempt has been performed.
String	getName()	Name of this task
long	getNextAttemptTime()	An indication about the time the next attempt will be made.
BackOffTimer.Task.Status	getStatus()	Gets the task status.
void	reset()	Reset the task.
void	whenComplete(BiConsumer<BackOffTimer.Task,Throwable> whenCompleted)	Action to execute when the context is completed (cancelled or exhausted)

Method Details

getName

String getName()

Name of this task

getBackOff

BackOff getBackOff()

The back-off associated with this task.

getStatus

BackOffTimer.Task.Status getStatus()

Gets the task status.

getCurrentAttempts

long getCurrentAttempts()

The number of attempts so far.

getCurrentDelay

long getCurrentDelay()

The current computed delay.

getCurrentElapsedTime

long getCurrentElapsedTime()

The current elapsed time.

getFirstAttemptTime

long getFirstAttemptTime()

The time the first attempt was performed.

getLastAttemptTime

long getLastAttemptTime()

The time the last attempt has been performed.

getNextAttemptTime

long getNextAttemptTime()

An indication about the time the next attempt will be made.

getException

Throwable getException()

The task failed for some un-expected exception

reset

void reset()

Reset the task.

cancel

void cancel()

Cancel the task.

whenComplete

void whenComplete(BiConsumer<BackOffTimer.Task,Throwable> whenCompleted)

Action to execute when the context is completed (cancelled or exhausted)

Parameters:

whenCompleted - the consumer.