org.apache.storm

Class StormTimer

java.lang.Object

org.apache.storm.StormTimer

All Implemented Interfaces:

AutoCloseable

public class StormTimer
extends Object
implements AutoCloseable

The timer defined in this file is very similar to java.util.Timer, except it integrates with Storm’s time simulation capabilities. This lets us test code that does asynchronous work on the timer thread

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StormTimer.QueueEntry
static class	StormTimer.StormTimerTask

Constructor Summary

Constructors

Constructor and Description
StormTimer(String name, Thread.UncaughtExceptionHandler onKill) Makes a Timer in the form of a StormTimerTask Object

Method Summary

Modifier and Type	Method and Description
void	close() cancel timer
boolean	isTimerWaiting() is timer waiting.
void	schedule(int delaySecs, Runnable func)
void	schedule(int delaySecs, Runnable func, boolean checkActive, int jitterMs) Schedule a function to be executed in the timer
void	scheduleRecurring(int delaySecs, int recurSecs, Runnable func) Schedule a function to run recurrently
void	scheduleRecurringWithJitter(int delaySecs, int recurSecs, int jitterMs, Runnable func) schedule a function to run recurrently with jitter

Methods inherited from class java.lang.Object

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

Constructor Detail

StormTimer

public StormTimer(String name,
                  Thread.UncaughtExceptionHandler onKill)

Makes a Timer in the form of a StormTimerTask Object

Parameters:

name - name of the timer

onKill - function to call when timer is killed unexpectedly

Method Detail

schedule

public void schedule(int delaySecs,
                     Runnable func,
                     boolean checkActive,
                     int jitterMs)

Schedule a function to be executed in the timer

Parameters:

delaySecs - the number of seconds to delay before running the function

func - the function to run

checkActive - whether to check is the timer is active

jitterMs - add jitter to the run

schedule

public void schedule(int delaySecs,
                     Runnable func)

scheduleRecurring

public void scheduleRecurring(int delaySecs,
                              int recurSecs,
                              Runnable func)

Schedule a function to run recurrently

Parameters:

delaySecs - the number of seconds to delay before running the function

recurSecs - the time between each invocation

func - the function to run

scheduleRecurringWithJitter

public void scheduleRecurringWithJitter(int delaySecs,
                                        int recurSecs,
                                        int jitterMs,
                                        Runnable func)

schedule a function to run recurrently with jitter

Parameters:

delaySecs - the number of seconds to delay before running the function

recurSecs - the time between each invocation

jitterMs - jitter added to the run

func - the function to run

close

public void close()
           throws Exception

cancel timer

Specified by:

close in interface AutoCloseable

Throws:

Exception

isTimerWaiting

public boolean isTimerWaiting()

is timer waiting. Used in timer simulation