org.apache.reef.wake.impl

Class TimerStage

java.lang.Object

org.apache.reef.wake.impl.TimerStage

All Implemented Interfaces:

AutoCloseable, Stage

public final class TimerStage
extends Object
implements Stage

Stage that triggers an event handler periodically.

Constructor Summary

Constructors

Constructor and Description
TimerStage(EventHandler<PeriodicEvent> handler, long period) Constructs a timer stage with no initial delay.
TimerStage(EventHandler<PeriodicEvent> handler, long initialDelay, long period) Constructs a timer stage.
TimerStage(String name, EventHandler<PeriodicEvent> handler, long period) Constructs a timer stage with no initial delay.
TimerStage(String name, EventHandler<PeriodicEvent> handler, long initialDelay, long period) Constructs a timer stage.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerStage

@Inject
public TimerStage(EventHandler<PeriodicEvent> handler,
                 long period)

Constructs a timer stage with no initial delay.

Parameters:

handler - an event handler

period - a period in milli-seconds

TimerStage

@Inject
public TimerStage(String name,
                 EventHandler<PeriodicEvent> handler,
                 long period)

Constructs a timer stage with no initial delay.

Parameters:

name - the stage name

handler - an event handler

period - a period in milli-seconds

TimerStage

@Inject
public TimerStage(EventHandler<PeriodicEvent> handler,
                 long initialDelay,
                 long period)

Constructs a timer stage.

Parameters:

handler - an event handler

initialDelay - an initial delay

period - a period in milli-seconds

TimerStage

@Inject
public TimerStage(String name,
                 EventHandler<PeriodicEvent> handler,
                 long initialDelay,
                 long period)

Constructs a timer stage.

Parameters:

name - the stage name

handler - an event handler

initialDelay - an initial delay

period - a period in milli-seconds

Method Detail

close

public void close()
           throws Exception

Closes resources.

Specified by:

close in interface AutoCloseable

Throws:

Exception