21.70. Class Heart
Namespace: ArmoniK.Core.Adapters.PubSub
Assembly: ArmoniK.Core.Adapters.PubSub.dll
Represents a heartbeat mechanism that executes a specified function at regular intervals.
public class Heart
21.70.1. Inheritance
21.70.2. Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
21.70.3. Constructors
21.70.3.1. Heart(Func<CancellationToken, Task>, TimeSpan, CancellationToken)
public Heart(Func<CancellationToken, Task> pulse, TimeSpan beatPeriod, CancellationToken cancellationToken = default)
21.70.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
21.70.4. Methods
21.70.4.1. Start()
Start the heart. If the heart is beating, it has no effect.
public void Start()
21.70.4.2. Stop()
Stops the heart
public Task Stop()
21.70.4.2.1. Returns
A task finishing with the last heartbeat