 |
 |
org.springframework.data.mongodb.core.messaging
Interface Task
-
- All Superinterfaces:
- Cancelable, Runnable, SchedulingAwareRunnable
public interface Task extends SchedulingAwareRunnable, Cancelable
The actualTaskto run within theMessageListenerContainer.- Since:
- 2.1
- Author:
- Christoph Strobl
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static classTask.StateTheTask.Statedefining the lifecycle phase the actualTask.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method and Description booleanawaitStart(Duration timeout)Synchronous, blocking call that awaits until thisTaskbecomes active.Task.StategetState()Get the current lifecycle phase.default booleanisActive()-
Methods inherited from interface org.springframework.scheduling.SchedulingAwareRunnable
isLongLived
-
Methods inherited from interface org.springframework.data.mongodb.core.messaging.Cancelable
cancel
-
-
-
-
Method Detail
-
isActive
default boolean isActive()
- Returns:
- true if the task is currently
running.
-
getState
Task.State getState()
Get the current lifecycle phase.- Returns:
- never null.
-
awaitStart
boolean awaitStart(Duration timeout) throws InterruptedException
Synchronous, blocking call that awaits until thisTaskbecomes active.- Parameters:
timeout- must not be null.- Returns:
trueif the task was started.falseif the waiting time elapsed before task was started.- Throws:
InterruptedException- if the current thread is interrupted while waiting.
-
-
|