Actor.StartPeriodicTimer method
Starts a periodic timer that sends a TimerElapsedEvent
to this actor after the specified due time, and then repeats after each specified period. The timer accepts an optional payload to be used during timeout. The timer can be stopped by invoking the StopTimer
method.
protected TimerInfo StartPeriodicTimer(TimeSpan startDelay, TimeSpan period,
TimerElapsedEvent customEvent = null)
parameter | description |
---|---|
startDelay | The amount of time to wait before sending the first timeout event. |
period | The time interval between timeout events. |
customEvent | Optional custom event to raise instead of the default TimerElapsedEvent. |
Return Value
Handle that contains information about the timer.
Remarks
See Using timers in actors for more information.
See Also
- class TimerInfo
- class TimerElapsedEvent
- class Actor
- namespace Microsoft.Coyote.Actors
- assembly Microsoft.Coyote.Actors