Class MessageExpiration<TPayload>.Builder

Namespace

PatternKit.Messaging.Reliability

Assembly

PatternKit.Core.dll

Fluent builder for MessageExpiration<TPayload>.

public sealed class MessageExpiration<TPayload>.Builder

Inheritance

object

MessageExpiration<TPayload>.Builder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Build()

Builds an immutable message-expiration policy.

public MessageExpiration<TPayload> Build()

Returns

MessageExpiration<TPayload>

Clock(Func<DateTimeOffset>)

Configures the clock used for stamping and evaluation.

public MessageExpiration<TPayload>.Builder Clock(Func<DateTimeOffset> clock)

Parameters

clock Func<DateTimeOffset>

Returns

MessageExpiration<TPayload>.Builder

DefaultTtl(TimeSpan)

Configures the default time-to-live used by Stamp(Message<TPayload>, TimeSpan?).

public MessageExpiration<TPayload>.Builder DefaultTtl(TimeSpan ttl)

Parameters

ttl TimeSpan

Returns

MessageExpiration<TPayload>.Builder

ExpiredReason(string)

Configures the rejection reason returned for expired messages.

public MessageExpiration<TPayload>.Builder ExpiredReason(string reason)

Parameters

reason string

Returns

MessageExpiration<TPayload>.Builder

Header(string)

Assigns the header used to store expiration deadlines.

public MessageExpiration<TPayload>.Builder Header(string headerName)

Parameters

headerName string

Returns

MessageExpiration<TPayload>.Builder

Name(string)

Assigns a policy name used in evaluation results.

public MessageExpiration<TPayload>.Builder Name(string name)

Parameters

name string

Returns

MessageExpiration<TPayload>.Builder

PreserveExisting(bool)

Configures whether stamping keeps an existing expiration deadline.

public MessageExpiration<TPayload>.Builder PreserveExisting(bool preserveExisting = true)

Parameters

preserveExisting bool

Returns

MessageExpiration<TPayload>.Builder