Class TimerGraphStageLogic
Timer-driven graph stage logic.
Implements
Inherited Members
Namespace: Akka.Streams.Stage
Assembly: Akka.Streams.dll
Syntax
public abstract class TimerGraphStageLogic : GraphStageLogic, IStageLoggingRemarks
To be thread safe the methods of this class must only be called from either the constructor of the graph operator during materialization or one of the methods invoked by the graph operator machinery, such as GraphStageLogic.OnPush
Constructors
| Edit this page View SourceTimerGraphStageLogic(Shape)
TBD
Declaration
protected TimerGraphStageLogic(Shape shape)Parameters
| Type | Name | Description |
|---|---|---|
| Shape | shape | TBD |
Methods
| Edit this page View SourceAfterPostStop()
TBD
Declaration
protected override void AfterPostStop()Overrides
| Edit this page View SourceCancelTimer(object)
Cancel timer, ensuring that the OnTimer(object) is not subsequently called.
Declaration
protected void CancelTimer(object timerKey)Parameters
| Type | Name | Description |
|---|---|---|
| object | timerKey | key of the timer to cancel |
IsTimerActive(object)
Inquire whether the timer is still active. Returns true unless the timer does not exist, has previously been canceled or if it was a single-shot timer that was already triggered.
Declaration
protected bool IsTimerActive(object timerKey)Parameters
| Type | Name | Description |
|---|---|---|
| object | timerKey | TBD |
Returns
| Type | Description |
|---|---|
| bool | TBD |
OnTimer(object)
Will be called when the scheduled timer is triggered.
Declaration
protected abstract void OnTimer(object timerKey)Parameters
| Type | Name | Description |
|---|---|---|
| object | timerKey | TBD |
ScheduleOnce(object, TimeSpan)
Schedule timer to call OnTimer(object) after given delay. Any existing timer with the same key will automatically be canceled before adding the new timer.
Declaration
protected void ScheduleOnce(object timerKey, TimeSpan delay)Parameters
| Type | Name | Description |
|---|---|---|
| object | timerKey | TBD |
| TimeSpan | delay | TBD |
ScheduleRepeatedly(object, TimeSpan)
Schedule timer to call OnTimer(object) periodically with the given interval after the specified initial delay. Any existing timer with the same key will automatically be canceled before adding the new timer.
Declaration
protected void ScheduleRepeatedly(object timerKey, TimeSpan interval)Parameters
| Type | Name | Description |
|---|---|---|
| object | timerKey | TBD |
| TimeSpan | interval | TBD |
ScheduleRepeatedly(object, TimeSpan, TimeSpan)
Schedule timer to call OnTimer(object) periodically with the given interval after the specified initial delay. Any existing timer with the same key will automatically be canceled before adding the new timer.
Declaration
protected void ScheduleRepeatedly(object timerKey, TimeSpan initialDelay, TimeSpan interval)Parameters
| Type | Name | Description |
|---|---|---|
| object | timerKey | TBD |
| TimeSpan | initialDelay | TBD |
| TimeSpan | interval | TBD |
Edit this page