Class DeviceHeartbeat

Namespace

Huddly.Sdk.Heartbeat

Assembly

Huddly.Sdk.dll

public sealed class DeviceHeartbeat : IDeviceHeartbeat, IDisposable

Inheritance

object

DeviceHeartbeat

Implements

IDeviceHeartbeat

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DeviceHeartbeat(ILogger<DeviceHeartbeat>, int, int)

public DeviceHeartbeat(ILogger<DeviceHeartbeat> logger, int deviceRequestTimeout = 3000, int deviceActivityGrace = 10000)

Parameters

logger ILogger<DeviceHeartbeat>

deviceRequestTimeout int

deviceActivityGrace int

Fields

DefaultDeviceHeartbeatInterval

public const int DefaultDeviceHeartbeatInterval = 10000

Field Value

int

Properties

IsRunning

True when the heartbeat has been started and not yet stopped. The background loop may drain briefly after a stop, but exits without invoking events.

public bool IsRunning { get; }

Property Value

bool

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Resume()

[Obsolete("Use Start() instead. Method will be removed in SDK version 3.")]
public void Resume()

Start(IDeviceMonitor, int)

public Task Start(IDeviceMonitor monitor, int probeInterval_ms)

Parameters

monitor IDeviceMonitor

probeInterval_ms int

Returns

Task

Stop()

public Task Stop()

Returns

Task

Suspend()

[Obsolete("Use Stop() instead. Method will be removed in SDK version 3.")]
public void Suspend()

Events

HeartbeatFailed

public event EventHandler<IDevice>? HeartbeatFailed

Event Type

EventHandler<IDevice>