Class MessageExpirationResult<TPayload>

Namespace

PatternKit.Messaging.Reliability

Assembly

PatternKit.Core.dll

Result returned by a message-expiration evaluation.

public sealed class MessageExpirationResult<TPayload>

Type Parameters

TPayload

Inheritance

object

MessageExpirationResult<TPayload>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CheckedAt

The time used to evaluate expiration.

public DateTimeOffset CheckedAt { get; }

Property Value

DateTimeOffset

Expired

True when the message has expired.

public bool Expired { get; }

Property Value

bool

ExpiresAt

The expiration deadline, or null when no expiration metadata was present.

public DateTimeOffset? ExpiresAt { get; }

Property Value

DateTimeOffset?

Message

The message evaluated by the policy.

public Message<TPayload> Message { get; }

Property Value

Message<TPayload>

PolicyName

The policy name that evaluated the message.

public string PolicyName { get; }

Property Value

string

Reason

Human-readable rejection reason when the message is expired.

public string? Reason { get; }

Property Value

string

Methods

Accepted(Message<TPayload>, string, DateTimeOffset, DateTimeOffset?)

Creates an accepted result.

public static MessageExpirationResult<TPayload> Accepted(Message<TPayload> message, string policyName, DateTimeOffset checkedAt, DateTimeOffset? expiresAt)

Parameters

message Message<TPayload>

policyName string

checkedAt DateTimeOffset

expiresAt DateTimeOffset?

Returns

MessageExpirationResult<TPayload>

Reject(Message<TPayload>, string, DateTimeOffset, DateTimeOffset, string)

Creates an expired result.

public static MessageExpirationResult<TPayload> Reject(Message<TPayload> message, string policyName, DateTimeOffset checkedAt, DateTimeOffset expiresAt, string reason)

Parameters

message Message<TPayload>

policyName string

checkedAt DateTimeOffset

expiresAt DateTimeOffset

reason string

Returns

MessageExpirationResult<TPayload>