Interface IQueryHealthTracker

Namespace
Cratis.Arc.Queries
Assembly
Cratis.Arc.Core.dll

Defines a service for tracking query subscription health.

public interface IQueryHealthTracker
Extension Methods

Methods

GetAllConnectionHealth()

Gets all connection health information.

IEnumerable<QueryConnectionHealth> GetAllConnectionHealth()

Returns

IEnumerable<QueryConnectionHealth>

Collection of query connection health.

ObserveHealth()

Gets an observable stream of connection health updates.

ISubject<IEnumerable<QueryConnectionHealth>> ObserveHealth()

Returns

ISubject<IEnumerable<QueryConnectionHealth>>

Observable subject emitting connection health snapshots.

RecordDataServed(string, string)

Updates the last data served timestamp for a subscription.

void RecordDataServed(string connectionId, string subscriptionId)

Parameters

connectionId string

The connection identifier.

subscriptionId string

The subscription identifier.

RecordPingSent(string, string)

Updates the last ping sent timestamp for a subscription.

void RecordPingSent(string connectionId, string subscriptionId)

Parameters

connectionId string

The connection identifier.

subscriptionId string

The subscription identifier.

RecordPongReceived(string, string)

Updates the last pong received timestamp for a subscription.

void RecordPongReceived(string connectionId, string subscriptionId)

Parameters

connectionId string

The connection identifier.

subscriptionId string

The subscription identifier.

RegisterSubscription(string, string, QuerySubscriptionMetadata)

Registers a new subscription.

void RegisterSubscription(string connectionId, string protocol, QuerySubscriptionMetadata metadata)

Parameters

connectionId string

The connection identifier.

protocol string

The connection protocol (WebSocket or SSE).

metadata QuerySubscriptionMetadata

The subscription metadata.

RemoveConnection(string)

Removes all subscriptions for a connection.

void RemoveConnection(string connectionId)

Parameters

connectionId string

The connection identifier.

UnregisterSubscription(string, string)

Unregisters a subscription.

void UnregisterSubscription(string connectionId, string subscriptionId)

Parameters

connectionId string

The connection identifier.

subscriptionId string

The subscription identifier.