Table of Contents

Interface IDeduplicationStrategy

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

Defines a contract for implementing message deduplication strategies.

public interface IDeduplicationStrategy
Extension Methods

Properties

DefaultExpiration

Gets the default expiration time for deduplication records.

TimeSpan DefaultExpiration { get; }

Property Value

TimeSpan

The duration deduplication entries remain valid.

Methods

GenerateDeduplicationId(string, IDictionary<string, object>?)

Generates a unique identifier for deduplication based on the message content.

string GenerateDeduplicationId(string messageBody, IDictionary<string, object>? messageAttributes = null)

Parameters

messageBody string

The message body.

messageAttributes IDictionary<string, object>

Optional message attributes.

Returns

string

A unique identifier for deduplication.

IsDuplicateAsync(string, CancellationToken)

Checks if a message has already been processed based on its deduplication ID.

Task<bool> IsDuplicateAsync(string deduplicationId, CancellationToken cancellationToken)

Parameters

deduplicationId string

The deduplication identifier.

cancellationToken CancellationToken

A cancellation token to cancel the operation.

Returns

Task<bool>

True if the message has been processed; otherwise, false.

MarkAsProcessedAsync(string, TimeSpan?, CancellationToken)

Marks a message as processed for deduplication purposes.

Task MarkAsProcessedAsync(string deduplicationId, TimeSpan? expiration, CancellationToken cancellationToken)

Parameters

deduplicationId string

The deduplication identifier.

expiration TimeSpan?

Optional expiration time for the deduplication record.

cancellationToken CancellationToken

A cancellation token to cancel the operation.

Returns

Task

A task that represents the asynchronous operation.

RemoveAsync(string, CancellationToken)

Removes a deduplication record.

Task<bool> RemoveAsync(string deduplicationId, CancellationToken cancellationToken)

Parameters

deduplicationId string

The deduplication identifier.

cancellationToken CancellationToken

A cancellation token to cancel the operation.

Returns

Task<bool>

True if the record was removed; otherwise, false.