Table of Contents

Interface ITransportHealthChecker

Namespace
Excalibur.Dispatch.Transport
Assembly
Excalibur.Dispatch.Abstractions.dll

Interface for transport health checking.

public interface ITransportHealthChecker
Extension Methods

Properties

Categories

Gets the health check categories supported by this checker.

TransportHealthCheckCategory Categories { get; }

Property Value

TransportHealthCheckCategory

Name

Gets the name of the health checker.

string Name { get; }

Property Value

string

TransportType

Gets the transport type being checked.

string TransportType { get; }

Property Value

string

Methods

CheckHealthAsync(TransportHealthCheckContext, CancellationToken)

Performs a health check operation.

Task<TransportHealthCheckResult> CheckHealthAsync(TransportHealthCheckContext context, CancellationToken cancellationToken)

Parameters

context TransportHealthCheckContext

The health check context.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TransportHealthCheckResult>

The health check result.

CheckQuickHealthAsync(CancellationToken)

Performs a quick health check operation (lighter than full check).

Task<TransportHealthCheckResult> CheckQuickHealthAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task<TransportHealthCheckResult>

The health check result.