Apache REEF  0.16.0
Retainable Evaluator Execution Framework
Public Member Functions | Public Attributes | List of all members
Org.Apache.REEF.Wake.Impl.TimerStage Class Reference

Stage that triggers an event handler periodically More...

Inherits Org.Apache.REEF.Wake.IStage.

Public Member Functions

 TimerStage (IEventHandler< PeriodicEvent > handler, long period)
 Constructs a timer stage with no initial delay More...
 
 TimerStage (IEventHandler< PeriodicEvent > handler, long initialDelay, long period)
 Constructs a timer stage More...
 
void Dispose ()
 Closes resources More...
 

Public Attributes

const long MaxTimeValue = int.MaxValue
 

Detailed Description

Stage that triggers an event handler periodically

Constructor & Destructor Documentation

◆ TimerStage() [1/2]

Org.Apache.REEF.Wake.Impl.TimerStage.TimerStage ( IEventHandler< PeriodicEvent handler,
long  period 
)
inline

Constructs a timer stage with no initial delay

Parameters
handleran event handler
perioda period in milli-seconds

◆ TimerStage() [2/2]

Org.Apache.REEF.Wake.Impl.TimerStage.TimerStage ( IEventHandler< PeriodicEvent handler,
long  initialDelay,
long  period 
)
inline

Constructs a timer stage

Parameters
handleran event handler
initialDelayan initial delay in the interval [0,MaxTimeValue]
perioda period in milli-seconds in the interval [0,MaxTimeValue]

Member Function Documentation

◆ Dispose()

void Org.Apache.REEF.Wake.Impl.TimerStage.Dispose ( )
inline

Closes resources

Member Data Documentation

◆ MaxTimeValue

const long Org.Apache.REEF.Wake.Impl.TimerStage.MaxTimeValue = int.MaxValue

The documentation for this class was generated from the following file: