Class OutboundQueueHealthCheckService

Checks that the outbound queue is being processed at a sustainable pace.

Inheritance

object

OutboundQueueHealthCheckService

Implements

IOutboundQueueHealthCheckService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Silverback.Messaging.HealthChecks

Assembly: Silverback.Integration.dll

Syntax

public class OutboundQueueHealthCheckService : IOutboundQueueHealthCheckService

Constructors

OutboundQueueHealthCheckService(IOutboxReader)

Initializes a new instance of the OutboundQueueHealthCheckService class.

Declaration

public OutboundQueueHealthCheckService(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 = null, int? maxQueueLength = null)

Parameters

Type	Name	Description
TimeSpan?	maxAge	The maximum message age, the check will fail when a message exceeds this age. The default is 30 seconds.
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

IOutboundQueueHealthCheckService