org.apache.flink.streaming.runtime.tasks

接口 TimerService

所有超级接口:

ProcessingTimeService

所有已知实现类:

SystemProcessingTimeService, TestProcessingTimeService

@Internal
public interface TimerService
extends ProcessingTimeService

A common timer service interface with life cycle methods.

The registration of timers follows a life cycle of three phases:

1. In the initial state, it accepts timer registrations and triggers when the time is reached.
2. After calling quiesce(), further calls to ProcessingTimeService.registerTimer(long, ProcessingTimeCallback) will not register any further timers, and will return a "dummy" future as a result. This is used for clean shutdown, where currently firing timers are waited for and no future timers can be scheduled, without causing hard exceptions.
3. After a call to shutdownService(), all calls to ProcessingTimeService.registerTimer(long, ProcessingTimeCallback) will result in a hard exception.

方法概要

限定符和类型	方法和说明
void	awaitPendingAfterQuiesce() This method can be used after calling quiesce(), and awaits the completion of currently executing timers.
boolean	isTerminated() Returns true if the service has been shut down, false otherwise.
void	quiesce() This method puts the service into a state where it does not register new timers, but returns for each call to ProcessingTimeService.registerTimer(long, ProcessingTimeCallback) only a "mock" future.
void	shutdownService() Shuts down and clean up the timer service provider hard and immediately.
boolean	shutdownServiceUninterruptible(long timeoutMs) Shuts down and clean up the timer service provider hard and immediately.

从接口继承的方法 org.apache.flink.streaming.runtime.tasks.ProcessingTimeService

getCurrentProcessingTime, registerTimer, scheduleAtFixedRate

方法详细资料

isTerminated

boolean isTerminated()

Returns true if the service has been shut down, false otherwise.

quiesce

void quiesce()
      throws InterruptedException

This method puts the service into a state where it does not register new timers, but returns for each call to ProcessingTimeService.registerTimer(long, ProcessingTimeCallback) only a "mock" future. Furthermore, the method clears all not yet started timers.

This method can be used to cleanly shut down the timer service. The using components will not notice that the service is shut down (as for example via exceptions when registering a new timer), but the service will simply not fire any timer any more.

抛出:

InterruptedException

awaitPendingAfterQuiesce

void awaitPendingAfterQuiesce()
                       throws InterruptedException

This method can be used after calling quiesce(), and awaits the completion of currently executing timers.

抛出:

InterruptedException

shutdownService

void shutdownService()

Shuts down and clean up the timer service provider hard and immediately. This does not wait for any timer to complete. Any further call to ProcessingTimeService.registerTimer(long, ProcessingTimeCallback) will result in a hard exception.

shutdownServiceUninterruptible

boolean shutdownServiceUninterruptible(long timeoutMs)

Shuts down and clean up the timer service provider hard and immediately. This does not wait for any timer to complete. Any further call to ProcessingTimeService.registerTimer(long, ProcessingTimeCallback) will result in a hard exception. This call cannot be interrupted and will block until the shutdown is completed or the timeout is exceeded.

参数:

timeoutMs - timeout for blocking on the service shutdown in milliseconds.

返回:

returns true iff the shutdown was completed.