Package org.apache.kafka.clients.consumer.internals

Class WakeupTrigger

java.lang.Object

org.apache.kafka.clients.consumer.internals.WakeupTrigger

public class WakeupTrigger
extends Object

Ensures blocking APIs can be woken up by the consumer.wakeup().

Constructor Summary

Constructors

Constructor	Description
WakeupTrigger()

Method Summary

Modifier and Type	Method	Description
void	clearTask()
void	maybeTriggerWakeup()
<T> CompletableFuture<T>	setActiveTask(CompletableFuture<T> currentTask)	If there is no pending task, set the pending task active.
void	setFetchAction(FetchBuffer fetchBuffer)
void	wakeup()	Wakeup a pending task.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WakeupTrigger

public WakeupTrigger()

Method Details

wakeup

public void wakeup()

Wakeup a pending task. If there isn't any pending task, return a WakeupFuture, so that the subsequent call would know wakeup was previously called.

If there are active tasks, complete it with WakeupException, then unset pending task (return null here. If the current task has already been woken-up, do nothing.

setActiveTask

public <T> CompletableFuture<T> setActiveTask(CompletableFuture<T> currentTask)

If there is no pending task, set the pending task active. If wakeup was called before setting an active task, the current task will complete exceptionally with WakeupException right away. if there is an active task, throw exception.

Type Parameters:

T -

Parameters:

currentTask -

Returns:

setFetchAction

public void setFetchAction(FetchBuffer fetchBuffer)

clearTask

public void clearTask()

maybeTriggerWakeup

public void maybeTriggerWakeup()