This project has retired. For details please refer to its Attic page.
Apache REEF: Org.Apache.REEF.Wake.Time.IClock Class Reference
Apache REEF  0.15.0
Retainable Evaluator Execution Framework
Classes | Public Member Functions | List of all members
Org.Apache.REEF.Wake.Time.IClock Class Referenceabstract

Inherits IDisposable.

Inherited by Org.Apache.REEF.Wake.Time.Runtime.RuntimeClock.

Classes

class  IdleHandler
 Bind this to an event handler to statically subscribe to the IdleClock Event More...
 
class  RuntimeStartHandler
 Bind this to an event handler to statically subscribe to the RuntimeStart Event More...
 
class  RuntimeStopHandler
 Bind this to an event handler to statically subscribe to the RuntimeStop Event More...
 
class  StartHandler
 Bind this to an event handler to statically subscribe to the StartTime Event More...
 
class  StopHandler
 Bind this to an event handler to statically subscribe to the StopTime Event More...
 

Public Member Functions

abstract void ScheduleAlarm (long offset, IObserver< Alarm > handler)
 Schedule a TimerEvent at the given future offset More...
 
abstract bool IsIdle ()
 Clock is idle if it has no future alarms set More...
 
abstract void Dispose ()
 Dispose of the clock and all scheduled alarms More...
 
abstract void Run ()
 Start the Clock. More...
 

Member Function Documentation

abstract void Org.Apache.REEF.Wake.Time.IClock.Dispose ( )
pure virtual

Dispose of the clock and all scheduled alarms

Implemented in Org.Apache.REEF.Wake.Time.Runtime.RuntimeClock.

abstract bool Org.Apache.REEF.Wake.Time.IClock.IsIdle ( )
pure virtual

Clock is idle if it has no future alarms set

Returns
True if no future alarms are set, otherwise false

Implemented in Org.Apache.REEF.Wake.Time.Runtime.RuntimeClock.

abstract void Org.Apache.REEF.Wake.Time.IClock.Run ( )
pure virtual

Start the Clock.

The clock will continue to run and handle events until it has been disposed.

Implemented in Org.Apache.REEF.Wake.Time.Runtime.RuntimeClock.

abstract void Org.Apache.REEF.Wake.Time.IClock.ScheduleAlarm ( long  offset,
IObserver< Alarm handler 
)
pure virtual

Schedule a TimerEvent at the given future offset

Parameters
offsetThe offset in the future to schedule the alarm
handlerThe IObserver to to be called

Implemented in Org.Apache.REEF.Wake.Time.Runtime.RuntimeClock.


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