Table of Contents

Class DeadLetterEntry

Namespace
Excalibur.Dispatch.ErrorHandling
Assembly
Excalibur.Dispatch.dll

Represents an entry in the dead letter queue with all relevant context for debugging and replay.

public sealed class DeadLetterEntry
Inheritance
DeadLetterEntry
Inherited Members
Extension Methods

Properties

CausationId

Gets the causation ID linking this message to its trigger.

public string? CausationId { get; init; }

Property Value

string

CorrelationId

Gets the correlation ID for tracking related messages.

public string? CorrelationId { get; init; }

Property Value

string

EnqueuedAt

Gets the timestamp when the message was enqueued to the dead letter queue.

public DateTimeOffset EnqueuedAt { get; init; }

Property Value

DateTimeOffset

ExceptionMessage

Gets the exception message if the dead lettering was caused by an exception.

public string? ExceptionMessage { get; init; }

Property Value

string

ExceptionStackTrace

Gets the exception stack trace if the dead lettering was caused by an exception.

public string? ExceptionStackTrace { get; init; }

Property Value

string

Id

Gets the unique identifier of the dead letter entry.

public Guid Id { get; init; }

Property Value

Guid

IsReplayed

Gets a value indicating whether this entry has been replayed.

public bool IsReplayed { get; init; }

Property Value

bool

MessageType

Gets the original message's explicit or declared identity, or an empty string when unknown. An unknown identity does not prevent failure capture; replay requires the configured handler to interpret the payload and must not treat an empty identity as a routable message name.

public required string MessageType { get; init; }

Property Value

string

Metadata

Gets additional metadata associated with the dead letter entry.

public IDictionary<string, string>? Metadata { get; init; }

Property Value

IDictionary<string, string>

OriginalAttempts

Gets the number of processing attempts before dead lettering.

public int OriginalAttempts { get; init; }

Property Value

int

Payload

Gets the serialized payload of the original message.

public required byte[] Payload { get; init; }

Property Value

byte[]

Reason

Gets the reason why the message was dead lettered.

public DeadLetterReason Reason { get; init; }

Property Value

DeadLetterReason

ReplayedAt

Gets the timestamp when the entry was replayed, if applicable.

public DateTimeOffset? ReplayedAt { get; init; }

Property Value

DateTimeOffset?

SourceQueue

Gets the source transport or queue where the message originated.

public string? SourceQueue { get; init; }

Property Value

string

TenantId

Gets the tenant that owns this entry, for operator inspection across a multi-tenant deployment.

public string? TenantId { get; init; }

Property Value

string

Remarks

Provenance only -- it does not confine what this entry can be read alongside or replayed into; a store's own confinement guarantee governs that. A provider with no tenant concept (e.g. a single-tenant deployment) leaves this null rather than inventing a value.