org.apache.flink.streaming.runtime.tasks

Class TestProcessingTimeService

java.lang.Object

org.apache.flink.streaming.runtime.tasks.ProcessingTimeService

org.apache.flink.streaming.runtime.tasks.TestProcessingTimeService

public class TestProcessingTimeService
extends ProcessingTimeService

This is a ProcessingTimeService used strictly for testing the processing time functionality.

Constructor Summary

Constructors

Constructor and Description
TestProcessingTimeService()

Method Summary

Modifier and Type	Method and Description
void	awaitPendingAfterQuiesce() This method can be used after calling ProcessingTimeService.quiesce(), and awaits the completion of currently executing timers.
Set<Long>	getActiveTimerTimestamps()
long	getCurrentProcessingTime() Returns the current processing time.
int	getNumActiveTimers()
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.
ScheduledFuture<?>	registerTimer(long timestamp, ProcessingTimeCallback target) Registers a task to be executed when (processing) time is timestamp.
ScheduledFuture<?>	scheduleAtFixedRate(ProcessingTimeCallback callback, long initialDelay, long period) Registers a task to be executed repeatedly at a fixed rate.
void	setCurrentTime(long timestamp)
boolean	shutdownAndAwaitPending(long time, TimeUnit timeUnit) Shuts down and clean up the timer service provider hard and immediately.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestProcessingTimeService

public TestProcessingTimeService()

Method Detail

setCurrentTime

public void setCurrentTime(long timestamp)
                    throws Exception

Throws:

Exception

getCurrentProcessingTime

public long getCurrentProcessingTime()

Description copied from class: ProcessingTimeService

Returns the current processing time.

Specified by:

getCurrentProcessingTime in class ProcessingTimeService

registerTimer

public ScheduledFuture<?> registerTimer(long timestamp,
                                        ProcessingTimeCallback target)

Description copied from class: ProcessingTimeService

Registers a task to be executed when (processing) time is timestamp.

Specified by:

registerTimer in class ProcessingTimeService

Parameters:

timestamp - Time when the task is to be executed (in processing time)

target - The task to be executed

Returns:

The future that represents the scheduled task. This always returns some future, even if the timer was shut down

scheduleAtFixedRate

public ScheduledFuture<?> scheduleAtFixedRate(ProcessingTimeCallback callback,
                                              long initialDelay,
                                              long period)

Description copied from class: ProcessingTimeService

Registers a task to be executed repeatedly at a fixed rate.

Specified by:

scheduleAtFixedRate in class ProcessingTimeService

Parameters:

callback - to be executed after the initial delay and then after each period

initialDelay - initial delay to start executing callback

period - after the initial delay after which the callback is executed

Returns:

Scheduled future representing the task to be executed repeatedly

isTerminated

public boolean isTerminated()

Description copied from class: ProcessingTimeService

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

Specified by:

isTerminated in class ProcessingTimeService

quiesce

public void quiesce()

Description copied from class: ProcessingTimeService

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.

Specified by:

quiesce in class ProcessingTimeService

awaitPendingAfterQuiesce

public void awaitPendingAfterQuiesce()
                              throws InterruptedException

Description copied from class: ProcessingTimeService

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

Specified by:

awaitPendingAfterQuiesce in class ProcessingTimeService

Throws:

InterruptedException

shutdownService

public void shutdownService()

Description copied from class: ProcessingTimeService

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.

Specified by:

shutdownService in class ProcessingTimeService

shutdownServiceUninterruptible

public boolean shutdownServiceUninterruptible(long timeoutMs)

Description copied from class: ProcessingTimeService

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.

Specified by:

shutdownServiceUninterruptible in class ProcessingTimeService

Parameters:

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

Returns:

returns true iff the shutdown was completed.

shutdownAndAwaitPending

public boolean shutdownAndAwaitPending(long time,
                                       TimeUnit timeUnit)
                                throws InterruptedException

Description copied from class: ProcessingTimeService

Shuts down and clean up the timer service provider hard and immediately. This does wait for all timers to complete or until the time limit is exceeded. Any call to ProcessingTimeService.registerTimer(long, ProcessingTimeCallback) will result in a hard exception after calling this method.

Specified by:

shutdownAndAwaitPending in class ProcessingTimeService

Parameters:

time - time to wait for termination.

timeUnit - time unit of parameter time.

Returns:

true if this timer service and all pending timers are terminated and false if the timeout elapsed before this happened.

Throws:

InterruptedException

getNumActiveTimers

public int getNumActiveTimers()

getActiveTimerTimestamps

public Set<Long> getActiveTimerTimestamps()