org.apache.kafka.queue

Class KafkaEventQueue

java.lang.Object

org.apache.kafka.queue.KafkaEventQueue

All Implemented Interfaces:

AutoCloseable, EventQueue

public final class KafkaEventQueue
extends Object
implements EventQueue

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kafka.queue.EventQueue

EventQueue.DeadlineFunction, EventQueue.EarliestDeadlineFunction, EventQueue.Event, EventQueue.EventInsertionType, EventQueue.FailureLoggingEvent, EventQueue.NoDeadlineFunction, EventQueue.VoidEvent

Constructor Summary

Constructors

Constructor and Description
KafkaEventQueue(org.apache.kafka.common.utils.Time time, org.apache.kafka.common.utils.LogContext logContext, String threadNamePrefix)
KafkaEventQueue(org.apache.kafka.common.utils.Time time, org.apache.kafka.common.utils.LogContext logContext, String threadNamePrefix, EventQueue.Event cleanupEvent)

Method Summary

Modifier and Type	Method and Description
void	beginShutdown(String source) Asynchronously shut down the event queue.
void	cancelDeferred(String tag) Cancel a deferred event.
void	close() Synchronously close the event queue and wait for any threads to be joined.
void	enqueue(EventQueue.EventInsertionType insertionType, String tag, Function<OptionalLong,OptionalLong> deadlineNsCalculator, EventQueue.Event event) Add an event to the queue.
int	size()
org.apache.kafka.common.utils.Time	time()
void	wakeup() This method is used during unit tests where MockTime is in use.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.queue.EventQueue

append, appendWithDeadline, isEmpty, prepend, scheduleDeferred

Constructor Detail

KafkaEventQueue

public KafkaEventQueue(org.apache.kafka.common.utils.Time time,
                       org.apache.kafka.common.utils.LogContext logContext,
                       String threadNamePrefix)

KafkaEventQueue

public KafkaEventQueue(org.apache.kafka.common.utils.Time time,
                       org.apache.kafka.common.utils.LogContext logContext,
                       String threadNamePrefix,
                       EventQueue.Event cleanupEvent)

Method Detail

time

public org.apache.kafka.common.utils.Time time()

enqueue

public void enqueue(EventQueue.EventInsertionType insertionType,
                    String tag,
                    Function<OptionalLong,OptionalLong> deadlineNsCalculator,
                    EventQueue.Event event)

Description copied from interface: EventQueue

Add an event to the queue.

Specified by:

enqueue in interface EventQueue

Parameters:

insertionType - How to insert the event. PREPEND means insert the event as the first thing to run. APPEND means insert the event as the last thing to run. DEFERRED means insert the event to run after a delay.

tag - If this is non-null, the unique tag to use for this event. If an event with this tag already exists, it will be cancelled.

deadlineNsCalculator - If this is non-null, it is a function which takes as an argument the existing deadline for the event with this tag (or null if the event has no tag, or if there is none such), and produces the deadline to use for this event (or empty to use none.) Events whose deadlines are only a few nanoseconds apart may be executed in any order.

event - The event to enqueue.

cancelDeferred

public void cancelDeferred(String tag)

Description copied from interface: EventQueue

Cancel a deferred event.

Specified by:

cancelDeferred in interface EventQueue

Parameters:

tag - The unique tag for the event to be cancelled. Must be non-null. If the event with the tag has not been scheduled, this call will be ignored.

beginShutdown

public void beginShutdown(String source)

Description copied from interface: EventQueue

Asynchronously shut down the event queue. No new events will be accepted, and the queue thread will exit after running the existing events. Deferred events will receive TimeoutExceptions.

Specified by:

beginShutdown in interface EventQueue

Parameters:

source - The source of the shutdown.

size

public int size()

Specified by:

size in interface EventQueue

Returns:

The number of pending and running events. If this is 0, there is no running event and no events queued.

wakeup

public void wakeup()

Description copied from interface: EventQueue

This method is used during unit tests where MockTime is in use. It is used to alert the queue that the mock time has changed.

Specified by:

wakeup in interface EventQueue

close

public void close()
           throws InterruptedException

Description copied from interface: EventQueue

Synchronously close the event queue and wait for any threads to be joined.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EventQueue

Throws:

InterruptedException