Class OutboxHealthCheckService

Checks that the outbox is being processed at a sustainable pace.

Inheritance

object

OutboxHealthCheckService

Implements

IOutboxHealthCheckService

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Silverback.Messaging.HealthChecks

Assembly: Silverback.Integration.dll

Syntax

public class OutboxHealthCheckService : IOutboxHealthCheckService

Constructors

OutboxHealthCheckService(IOutboxReader)

Initializes a new instance of the OutboxHealthCheckService class.

Declaration

public OutboxHealthCheckService(IOutboxReader queueReader)

Parameters

Type	Name	Description
IOutboxReader	queueReader	The IOutboxReader.

Methods

CheckIsHealthyAsync(TimeSpan, int?)

Checks the age of the messages stored in the transactional outbox and optionally the queue length.

Declaration

public Task<bool> CheckIsHealthyAsync(TimeSpan maxAge, int? maxQueueLength = null)

Parameters

Type	Name	Description
TimeSpan	maxAge	The maximum message age, the check will fail when a message exceeds this age.
int?	maxQueueLength	The maximum amount of messages in the queue. The default is null, meaning unrestricted.

Returns

Type	Description
Task<bool>	A Task<TResult> representing the asynchronous operation. The task result contains a boolean value indicating whether the check is successful.

Implements

IOutboxHealthCheckService