17.93. Class Heart
Namespace: ArmoniK.Core.Adapters.SQS
Assembly: ArmoniK.Core.Adapters.SQS.dll
public class Heart
17.93.1. Inheritance
17.93.2. Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
17.93.3. Constructors
17.93.3.1. Heart(Func<CancellationToken, Task>, TimeSpan, CancellationToken)
public Heart(Func<CancellationToken, Task> pulse, TimeSpan beatPeriod, CancellationToken cancellationToken = default)
17.93.3.1.1. Parameters
pulse Func<CancellationToken, Task>
The function to execute at each beat It returns a predicate indicating if the heart must continue beating
beatPeriod TimeSpan
Defines the timespan between two heartbeats
cancellationToken CancellationToken
17.93.4. Methods
17.93.4.1. Start()
Start the heart. If the heart is beating, it has no effect.
public void Start()
17.93.4.2. Stop()
Stops the heart
public Task Stop()
17.93.4.2.1. Returns
A task finishing with the last heartbeat