Table of Contents

Class MessageContextFeatureExtensions

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

Extension methods for accessing feature interfaces on IMessageContext.

public static class MessageContextFeatureExtensions
Inheritance
MessageContextFeatureExtensions
Inherited Members

Methods

CreateChildContext(IMessageContext, IServiceProvider?)

Creates a child context for dispatching related messages. Propagates cross-cutting identifiers (correlation, identity), routing source, and the parent's Items baggage from the parent.

public static IMessageContext CreateChildContext(this IMessageContext context, IServiceProvider? requestServices = null)

Parameters

context IMessageContext

The parent message context.

requestServices IServiceProvider

The service provider for the child context.

Returns

IMessageContext

A new IMessageContext with propagated identifiers and baggage.

Remarks

The parent's Items are copied into the child so a child dispatch keeps the same ambient request-local state a context-reuse dispatch would. The copy is per-entry into a fresh dictionary, so adding or removing an entry on the child does not affect the parent. It does not deep-copy an entry's value: a mutable object stored in Items is shared by both contexts, as it would be by any two references to it.

The values marked with SetPropagatedItem(IMessageContext, string, string) are copied as well, into a collection the child owns.

GetDeliveryCount(IMessageContext)

Gets the delivery count from the processing feature.

public static int GetDeliveryCount(this IMessageContext context)

Parameters

context IMessageContext

Returns

int

GetExternalId(IMessageContext)

Gets the external ID from the identity feature.

public static string? GetExternalId(this IMessageContext context)

Parameters

context IMessageContext

Returns

string

GetFeature<TFeature>(IMessageContext)

Gets the feature of the specified type from the context's Features dictionary.

public static TFeature? GetFeature<TFeature>(this IMessageContext context) where TFeature : class

Parameters

context IMessageContext

The message context.

Returns

TFeature

The feature instance, or null if not set.

Type Parameters

TFeature

The feature type.

GetFirstAttemptTime(IMessageContext)

Gets the first attempt time from the processing feature.

public static DateTimeOffset? GetFirstAttemptTime(this IMessageContext context)

Parameters

context IMessageContext

Returns

DateTimeOffset?

GetIdentityFeature(IMessageContext)

Gets the identity feature, or null if not set.

public static IMessageIdentityFeature? GetIdentityFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageIdentityFeature

GetInboxLeaseFeature(IMessageContext)

Gets the inbox lease feature, or null if not set.

public static IInboxLeaseFeature? GetInboxLeaseFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IInboxLeaseFeature

GetIsRetry(IMessageContext)

Gets whether this is a retry from the processing feature.

public static bool GetIsRetry(this IMessageContext context)

Parameters

context IMessageContext

Returns

bool

GetOrCreateFeature<TFeature, TDefault>(IMessageContext)

Gets or creates the feature of the specified type.

public static TFeature GetOrCreateFeature<TFeature, TDefault>(this IMessageContext context) where TFeature : class where TDefault : TFeature, new()

Parameters

context IMessageContext

The message context.

Returns

TFeature

The existing or newly created feature instance.

Type Parameters

TFeature

The feature interface type.

TDefault

The default implementation type.

GetOrCreateIdentityFeature(IMessageContext)

Gets or creates the identity feature with default implementation.

public static IMessageIdentityFeature GetOrCreateIdentityFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageIdentityFeature

GetOrCreateInboxLeaseFeature(IMessageContext)

Gets or creates the inbox lease feature with default implementation.

public static IInboxLeaseFeature GetOrCreateInboxLeaseFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IInboxLeaseFeature

GetOrCreateProcessingFeature(IMessageContext)

Gets or creates the processing feature with default implementation.

public static IMessageProcessingFeature GetOrCreateProcessingFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageProcessingFeature

GetOrCreateRateLimitFeature(IMessageContext)

Gets or creates the rate limit feature with default implementation.

public static IMessageRateLimitFeature GetOrCreateRateLimitFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageRateLimitFeature

GetOrCreateRoutingFeature(IMessageContext)

Gets or creates the routing feature with default implementation.

public static IMessageRoutingFeature GetOrCreateRoutingFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageRoutingFeature

GetOrCreateTimeoutFeature(IMessageContext)

Gets or creates the timeout feature with default implementation.

public static IMessageTimeoutFeature GetOrCreateTimeoutFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageTimeoutFeature

GetOrCreateTransactionFeature(IMessageContext)

Gets or creates the transaction feature with default implementation.

public static IMessageTransactionFeature GetOrCreateTransactionFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageTransactionFeature

GetOrCreateValidationFeature(IMessageContext)

Gets or creates the validation feature with default implementation.

public static IMessageValidationFeature GetOrCreateValidationFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageValidationFeature

GetPartitionKey(IMessageContext)

Gets the partition key from the routing feature.

public static string? GetPartitionKey(this IMessageContext context)

Parameters

context IMessageContext

Returns

string

GetProcessingAttempts(IMessageContext)

Gets the processing attempts from the processing feature.

public static int GetProcessingAttempts(this IMessageContext context)

Parameters

context IMessageContext

Returns

int

GetProcessingFeature(IMessageContext)

Gets the processing feature, or null if not set.

public static IMessageProcessingFeature? GetProcessingFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageProcessingFeature

GetRateLimitExceeded(IMessageContext)

Gets whether the rate limit was exceeded from the rate limit feature.

public static bool GetRateLimitExceeded(this IMessageContext context)

Parameters

context IMessageContext

Returns

bool

GetRateLimitFeature(IMessageContext)

Gets the rate limit feature, or null if not set.

public static IMessageRateLimitFeature? GetRateLimitFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageRateLimitFeature

GetRateLimitRetryAfter(IMessageContext)

Gets the rate limit retry-after duration from the rate limit feature.

public static TimeSpan? GetRateLimitRetryAfter(this IMessageContext context)

Parameters

context IMessageContext

Returns

TimeSpan?

GetRoutingDecision(IMessageContext)

Gets the routing decision from the routing feature.

public static RoutingDecision? GetRoutingDecision(this IMessageContext context)

Parameters

context IMessageContext

Returns

RoutingDecision

GetRoutingFeature(IMessageContext)

Gets the routing feature, or null if not set.

public static IMessageRoutingFeature? GetRoutingFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageRoutingFeature

GetSessionId(IMessageContext)

Gets the session ID from the identity feature.

public static string? GetSessionId(this IMessageContext context)

Parameters

context IMessageContext

Returns

string

GetSource(IMessageContext)

Gets the source from the routing feature.

public static string? GetSource(this IMessageContext context)

Parameters

context IMessageContext

Returns

string

GetTenantId(IMessageContext)

Gets the tenant ID from the identity feature.

public static string? GetTenantId(this IMessageContext context)

Parameters

context IMessageContext

Returns

string

GetTimeoutElapsed(IMessageContext)

Gets the timeout elapsed from the timeout feature.

public static TimeSpan? GetTimeoutElapsed(this IMessageContext context)

Parameters

context IMessageContext

Returns

TimeSpan?

GetTimeoutExceeded(IMessageContext)

Gets whether the timeout was exceeded from the timeout feature.

public static bool GetTimeoutExceeded(this IMessageContext context)

Parameters

context IMessageContext

Returns

bool

GetTimeoutFeature(IMessageContext)

Gets the timeout feature, or null if not set.

public static IMessageTimeoutFeature? GetTimeoutFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageTimeoutFeature

GetTraceParent(IMessageContext)

Gets the trace parent from the identity feature.

public static string? GetTraceParent(this IMessageContext context)

Parameters

context IMessageContext

Returns

string

GetTransaction(IMessageContext)

Gets the transaction object from the transaction feature.

public static object? GetTransaction(this IMessageContext context)

Parameters

context IMessageContext

Returns

object

GetTransactionFeature(IMessageContext)

Gets the transaction feature, or null if not set.

public static IMessageTransactionFeature? GetTransactionFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageTransactionFeature

GetTransactionId(IMessageContext)

Gets the transaction ID from the transaction feature.

public static string? GetTransactionId(this IMessageContext context)

Parameters

context IMessageContext

Returns

string

GetUserId(IMessageContext)

Gets the user ID from the identity feature.

public static string? GetUserId(this IMessageContext context)

Parameters

context IMessageContext

Returns

string

GetValidationFeature(IMessageContext)

Gets the validation feature, or null if not set.

public static IMessageValidationFeature? GetValidationFeature(this IMessageContext context)

Parameters

context IMessageContext

Returns

IMessageValidationFeature

GetValidationPassed(IMessageContext)

Gets whether validation passed from the validation feature.

public static bool GetValidationPassed(this IMessageContext context)

Parameters

context IMessageContext

Returns

bool

GetValidationTimestamp(IMessageContext)

Gets the validation timestamp from the validation feature.

public static DateTimeOffset? GetValidationTimestamp(this IMessageContext context)

Parameters

context IMessageContext

Returns

DateTimeOffset?

GetWorkflowId(IMessageContext)

Gets the workflow ID from the identity feature.

public static string? GetWorkflowId(this IMessageContext context)

Parameters

context IMessageContext

Returns

string

SetFeature<TFeature>(IMessageContext, TFeature?)

Sets the feature of the specified type in the context's Features dictionary.

public static void SetFeature<TFeature>(this IMessageContext context, TFeature? feature) where TFeature : class

Parameters

context IMessageContext

The message context.

feature TFeature

The feature instance, or null to remove.

Type Parameters

TFeature

The feature type.