org.apache.kafka.server.util

Class KafkaScheduler

java.lang.Object

org.apache.kafka.server.util.KafkaScheduler

All Implemented Interfaces:

Scheduler

public class KafkaScheduler
extends Object
implements Scheduler

A scheduler based on java.util.concurrent.ScheduledThreadPoolExecutor It has a pool of kafka-scheduler- threads that do the actual work.

Constructor Summary

Constructors

Constructor and Description
KafkaScheduler(int threads)
KafkaScheduler(int threads, boolean daemon)
KafkaScheduler(int threads, boolean daemon, boolean trackStuckIO)
KafkaScheduler(int threads, boolean daemon, String threadNamePrefix, boolean trackStuckIO)

Method Summary

Modifier and Type	Method and Description
boolean	isStarted()
void	resizeThreadPool(int newSize)
ScheduledFuture<?>	schedule(String name, Runnable task, long delayMs, long periodMs) Schedule a task.
void	shutdown() Shutdown this scheduler.
int	size() Returns the number of pending tasks.
void	startup() Initialize this scheduler so it is ready to accept scheduling of tasks
boolean	taskRunning(ScheduledFuture<?> task)
String	threadNamePrefix()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.server.util.Scheduler

scheduleOnce, scheduleOnce

Constructor Detail

KafkaScheduler

public KafkaScheduler(int threads)

KafkaScheduler

public KafkaScheduler(int threads,
                      boolean daemon)

KafkaScheduler

public KafkaScheduler(int threads,
                      boolean daemon,
                      boolean trackStuckIO)

KafkaScheduler

public KafkaScheduler(int threads,
                      boolean daemon,
                      String threadNamePrefix,
                      boolean trackStuckIO)

Method Detail

startup

public void startup()

Description copied from interface: Scheduler

Initialize this scheduler so it is ready to accept scheduling of tasks

Specified by:

startup in interface Scheduler

shutdown

public void shutdown()
              throws InterruptedException

Description copied from interface: Scheduler

Shutdown this scheduler. When this method is complete no more executions of background tasks will occur. This includes tasks scheduled with a delayed execution.

Specified by:

shutdown in interface Scheduler

Throws:

InterruptedException

schedule

public ScheduledFuture<?> schedule(String name,
                                   Runnable task,
                                   long delayMs,
                                   long periodMs)

Description copied from interface: Scheduler

Schedule a task.

Specified by:

schedule in interface Scheduler

Parameters:

name - The name of this task

task - The task to run

delayMs - The number of milliseconds to wait before the first execution

periodMs - The period in milliseconds with which to execute the task. If periodMs is less than 0 the task will execute only once.

Returns:

A Future object to manage the task scheduled.

isStarted

public final boolean isStarted()

resizeThreadPool

public void resizeThreadPool(int newSize)

Specified by:

resizeThreadPool in interface Scheduler

size

public int size()

Description copied from interface: Scheduler

Returns the number of pending tasks.

Specified by:

size in interface Scheduler

threadNamePrefix

public String threadNamePrefix()

taskRunning

public boolean taskRunning(ScheduledFuture<?> task)