Table of Contents

Enum SagaTimeoutRetirementOutcome

Namespace
Excalibur.Saga.Abstractions
Assembly
Excalibur.Saga.dll

The result of asking a store to retire a delivered timeout.

public enum SagaTimeoutRetirementOutcome

Fields

Retired = 0

The caller held the current claim and the timeout was retired. Delivery is complete.

Superseded = 1

The caller's claim is no longer the current one, so nothing was retired.

The lease expired and another processor re-claimed the timeout, which is the case the lease exists to handle. The caller must not report the timeout as delivered on its own behalf: the live claim holder owns the outcome now. This is an ordinary, expected result under a multi-instance deployment and is not an error.

Remarks

Retirement can decline, so it reports rather than returning nothing. A call that removed no row and a call that removed the row are different outcomes with different consequences for the caller, and a void return made them the same observation.

There are deliberately two values and not three. "The row was not found" is not separable from "another claim retired it": once the row is gone the store cannot tell those apart, so a third value would invent a distinction no implementation can honour.