Actor.StartTimer method
Starts a timer that sends a TimerElapsedEvent
to this actor after the specified due time. The timer accepts an optional payload to be used during timeout. The timer is automatically disposed after it timeouts. To manually stop and dispose the timer, invoke the StopTimer
method.
protected TimerInfo StartTimer(TimeSpan startDelay, TimerElapsedEvent customEvent = null)
parameter | description |
---|---|
startDelay | The amount of time to wait before sending the timeout event. |
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