Table of Contents

Interface IInboxStoreCapabilities

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

Reports the effective durable capabilities of an IInboxStore, composing through decorator chains so a startup capability guard can probe the true innermost behavior rather than a statically-declared interface that may throw at runtime.

public interface IInboxStoreCapabilities
Extension Methods

Remarks

A decorating inbox store (for example a transparent-encryption decorator) typically declares the segregated capability interfaces (IClaimableInboxStore, IProcessingTrackingInboxStore) so it can forward them to its inner store. A simple is IClaimableInboxStore check therefore passes for the decorator even when the wrapped inner store lacks the capability — the decorator then throws NotSupportedException at first call (pass-then-throw-at-runtime). A decorator that implements this interface instead reports the capability it can actually forward, letting the ValidateOnStart presence-guards fail fast at startup and making the runtime NotSupportedException structurally unreachable.

Implementations MUST report the effective capability and compose through chains: a decorator reports true when its inner store either directly implements the matching capability interface or itself reports true via this interface. Plain (non-decorating) stores do not need to implement this interface; the guards fall back to the direct interface check for them.

Properties

SupportsBackoffScheduling

Gets a value indicating whether the store can durably record a per-entry next-attempt time (the effective IBackoffSchedulableInboxStore capability, forwarded through any decoration).

bool SupportsBackoffScheduling { get; }

Property Value

bool

true if a backoff schedule can be forwarded to a capable store; otherwise false (the caller falls back to the plain failed status and its fixed re-admission window).

Remarks

This capability is the one whose absence is INVISIBLE at the call site, which is why it belongs on this panel rather than being left to a type check. Every other capability here fails loudly when it is missing: the call throws, or a startup guard refuses the configuration. A missing backoff schedule does neither -- the entry is still marked failed, the call still returns successfully, and the only symptom is that the computed delay never throttles re-delivery, so a poison message is retried on the fixed re-admission window instead of an exponential one.

IBackoffSchedulableInboxStore documents that fallback, and locates it in the CALLER: the processor falls back, having first observed that the store is not schedulable. A decorator that declares the interface in order to forward it destroys exactly that observability -- the caller sees a schedulable store, and the decorator silently performs the fallback on its behalf. Reporting the effective capability here restores the caller's ability to see what it is actually getting.

SupportsClaim

Gets a value indicating whether the store can atomically claim a message for idempotent processing (the effective IClaimableInboxStore capability, forwarded through any decoration).

bool SupportsClaim { get; }

Property Value

bool

true if an atomic claim/release can be forwarded to a capable store; otherwise false.

SupportsLeasedClaim

Gets a value indicating whether the store can acquire a self-expiring lease on a message (the effective ILeasedInboxStore capability, forwarded through any decoration).

bool SupportsLeasedClaim { get; }

Property Value

bool

true if a lease acquisition can be forwarded to a capable store; otherwise false.

Remarks

Distinct from SupportsClaim: the two are separate protocols that disagree about the state space they admit, about who ends a claim, and about whether a stuck claim recovers on its own. One boolean cannot answer for both, and a store may support either without the other.

SupportsProcessingTracking

Gets a value indicating whether the store can durably persist the in-flight Processing status (the effective IProcessingTrackingInboxStore capability, forwarded through any decoration).

bool SupportsProcessingTracking { get; }

Property Value

bool

true if durable Processing tracking can be forwarded to a capable store; otherwise false.

SupportsScopedTransactional

Gets a value indicating whether the store offers the document-store transactional seam specifically (the effective IScopedTransactionalInboxStore capability, forwarded through any decoration), which hands the handler a scope to enlist its own writes into.

bool SupportsScopedTransactional { get; }

Property Value

bool

true if a scoped transactional handler+mark can be forwarded to a capable store; otherwise false.

Remarks

Distinct from SupportsTransactional, which is satisfied by either seam. The two seams differ in what the handler receives — the scoped seam yields an IInboxTransactionScope the handler enlists into, the relational seam does not — so a caller that needs to write alongside the mark cannot act on the union flag. Reporting the seam separately is what lets that caller discover the boundary instead of discovering it as a failed cast at first use.

SupportsTransactional

Gets a value indicating whether the store can process a message and mark it processed inside a single enlisting transaction, enabling exactly-once processing.

bool SupportsTransactional { get; }

Property Value

bool

true if transactional handler+mark can be forwarded to a capable store over either seam; otherwise false (the store falls back to the documented at-least-once claim protocol).

Remarks

This answers for EITHER transactional seam: the relational ITransactionalInboxStore or the document-store IScopedTransactionalInboxStore. It is a guarantee flag, not a type test, and true is therefore NOT a licence to cast: a document store answers true here while implementing only the scoped seam, and a cast to ITransactionalInboxStore against it fails. Use SupportsScopedTransactional to discover which seam is available before casting.