org.apache.kafka.server.util

Interface Scheduler

All Known Implementing Classes:

KafkaScheduler

public interface Scheduler

A scheduler for running jobs This interface controls a job scheduler that allows scheduling either repeating background jobs that execute periodically or delayed one-time actions that are scheduled in the future.

Method Summary

Modifier and Type	Method and Description
void	resizeThreadPool(int newSize)
ScheduledFuture<?>	schedule(String name, Runnable task, long delayMs, long periodMs) Schedule a task.
default ScheduledFuture<?>	scheduleOnce(String name, Runnable task)
default ScheduledFuture<?>	scheduleOnce(String name, Runnable task, long delayMs)
void	shutdown() Shutdown this scheduler.
void	startup() Initialize this scheduler so it is ready to accept scheduling of tasks

Method Detail

startup

void startup()

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

shutdown

void shutdown()
       throws InterruptedException

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

Throws:

InterruptedException

scheduleOnce

default ScheduledFuture<?> scheduleOnce(String name,
                                        Runnable task)

scheduleOnce

default ScheduledFuture<?> scheduleOnce(String name,
                                        Runnable task,
                                        long delayMs)

schedule

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

Schedule a task.

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 < 0 the task will execute only once.

Returns:

A Future object to manage the task scheduled.

resizeThreadPool

void resizeThreadPool(int newSize)