Interface ConsumeContext

Namespace

MassTransit

Assembly

MassTransit.Abstractions.dll

public interface ConsumeContext : PipeContext, MessageContext, IPublishEndpoint, IPublishObserverConnector, ISendEndpointProvider, ISendObserverConnector

Inherited Members

PipeContext.HasPayloadType(Type)

PipeContext.TryGetPayload<T>(out T)

PipeContext.GetOrAddPayload<T>(PayloadFactory<T>)

PipeContext.AddOrUpdatePayload<T>(PayloadFactory<T>, UpdatePayloadFactory<T>)

PipeContext.CancellationToken

MessageContext.MessageId

MessageContext.RequestId

MessageContext.CorrelationId

MessageContext.ConversationId

MessageContext.InitiatorId

MessageContext.ExpirationTime

MessageContext.SourceAddress

MessageContext.DestinationAddress

MessageContext.ResponseAddress

MessageContext.FaultAddress

MessageContext.SentTime

MessageContext.Headers

MessageContext.Host

IPublishEndpoint.Publish<T>(T, CancellationToken)

IPublishEndpoint.Publish<T>(T, IPipe<PublishContext<T>>, CancellationToken)

IPublishEndpoint.Publish<T>(T, IPipe<PublishContext>, CancellationToken)

IPublishEndpoint.Publish(object, CancellationToken)

IPublishEndpoint.Publish(object, IPipe<PublishContext>, CancellationToken)

IPublishEndpoint.Publish(object, Type, CancellationToken)

IPublishEndpoint.Publish(object, Type, IPipe<PublishContext>, CancellationToken)

IPublishEndpoint.Publish<T>(object, CancellationToken)

IPublishEndpoint.Publish<T>(object, IPipe<PublishContext<T>>, CancellationToken)

IPublishEndpoint.Publish<T>(object, IPipe<PublishContext>, CancellationToken)

IPublishObserverConnector.ConnectPublishObserver(IPublishObserver)

ISendEndpointProvider.GetSendEndpoint(Uri)

ISendObserverConnector.ConnectSendObserver(ISendObserver)

Extension Methods

CancelScheduledSendExtensions.CancelScheduledSend<T>(ConsumeContext, ScheduledMessage<T>)

ConsumeContextSchedulerExtensions.ScheduleSend(ConsumeContext, Uri, DateTime, object, IPipe<SendContext>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend(ConsumeContext, Uri, DateTime, object, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend(ConsumeContext, Uri, DateTime, object, Type, IPipe<SendContext>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend(ConsumeContext, Uri, DateTime, object, Type, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend(ConsumeContext, Uri, TimeSpan, object, IPipe<SendContext>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend(ConsumeContext, Uri, TimeSpan, object, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend(ConsumeContext, Uri, TimeSpan, object, Type, IPipe<SendContext>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend(ConsumeContext, Uri, TimeSpan, object, Type, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, DateTime, object, IPipe<SendContext<T>>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, DateTime, object, IPipe<SendContext>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, DateTime, object, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, DateTime, T, IPipe<SendContext<T>>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, DateTime, T, IPipe<SendContext>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, DateTime, T, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, TimeSpan, object, IPipe<SendContext<T>>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, TimeSpan, object, IPipe<SendContext>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, TimeSpan, object, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, TimeSpan, T, IPipe<SendContext<T>>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, TimeSpan, T, IPipe<SendContext>, CancellationToken)

ConsumeContextSchedulerExtensions.ScheduleSend<T>(ConsumeContext, Uri, TimeSpan, T, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend(ConsumeContext, DateTime, object, IPipe<SendContext>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend(ConsumeContext, DateTime, object, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend(ConsumeContext, DateTime, object, Type, IPipe<SendContext>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend(ConsumeContext, DateTime, object, Type, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend(ConsumeContext, TimeSpan, object, IPipe<SendContext>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend(ConsumeContext, TimeSpan, object, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend(ConsumeContext, TimeSpan, object, Type, IPipe<SendContext>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend(ConsumeContext, TimeSpan, object, Type, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, DateTime, object, IPipe<SendContext<T>>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, DateTime, object, IPipe<SendContext>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, DateTime, object, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, DateTime, T, IPipe<SendContext<T>>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, DateTime, T, IPipe<SendContext>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, DateTime, T, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, TimeSpan, object, IPipe<SendContext<T>>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, TimeSpan, object, IPipe<SendContext>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, TimeSpan, object, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, TimeSpan, T, IPipe<SendContext<T>>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, TimeSpan, T, IPipe<SendContext>, CancellationToken)

ConsumeContextSelfSchedulerExtensions.ScheduleSend<T>(ConsumeContext, TimeSpan, T, CancellationToken)

RespondAsyncExecuteExtensions.RespondAsync(ConsumeContext, object, Action<SendContext>)

RespondAsyncExecuteExtensions.RespondAsync(ConsumeContext, object, Func<SendContext, Task>)

RespondAsyncExecuteExtensions.RespondAsync(ConsumeContext, object, Type, Action<SendContext>)

RespondAsyncExecuteExtensions.RespondAsync(ConsumeContext, object, Type, Func<SendContext, Task>)

RespondAsyncExecuteExtensions.RespondAsync<T>(ConsumeContext, object, Action<SendContext<T>>)

RespondAsyncExecuteExtensions.RespondAsync<T>(ConsumeContext, object, Func<SendContext<T>, Task>)

RespondAsyncExecuteExtensions.RespondAsync<T>(ConsumeContext, T, Action<SendContext<T>>)

RespondAsyncExecuteExtensions.RespondAsync<T>(ConsumeContext, T, Func<SendContext<T>, Task>)

ResponseExtensions.IsResponseAccepted<T>(ConsumeContext, bool)

RetryContextExtensions.GetRedeliveryCount(ConsumeContext)

RetryContextExtensions.GetRetryAttempt(ConsumeContext)

RetryContextExtensions.GetRetryCount(ConsumeContext)

RoutingKeyExtensions.RoutingKey(ConsumeContext)

RoutingSlipExtensions.Execute<T>(T, RoutingSlip)

SchedulePublishExtensions.SchedulePublish(ConsumeContext, DateTime, object, IPipe<SendContext>, CancellationToken)

SchedulePublishExtensions.SchedulePublish(ConsumeContext, DateTime, object, CancellationToken)

SchedulePublishExtensions.SchedulePublish(ConsumeContext, DateTime, object, Type, IPipe<SendContext>, CancellationToken)

SchedulePublishExtensions.SchedulePublish(ConsumeContext, DateTime, object, Type, CancellationToken)

SchedulePublishExtensions.SchedulePublish(ConsumeContext, TimeSpan, object, IPipe<SendContext>, CancellationToken)

SchedulePublishExtensions.SchedulePublish(ConsumeContext, TimeSpan, object, CancellationToken)

SchedulePublishExtensions.SchedulePublish(ConsumeContext, TimeSpan, object, Type, IPipe<SendContext>, CancellationToken)

SchedulePublishExtensions.SchedulePublish(ConsumeContext, TimeSpan, object, Type, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, DateTime, object, IPipe<SendContext<T>>, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, DateTime, object, IPipe<SendContext>, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, DateTime, object, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, DateTime, T, IPipe<SendContext<T>>, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, DateTime, T, IPipe<SendContext>, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, DateTime, T, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, TimeSpan, object, IPipe<SendContext<T>>, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, TimeSpan, object, IPipe<SendContext>, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, TimeSpan, object, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, TimeSpan, T, IPipe<SendContext<T>>, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, TimeSpan, T, IPipe<SendContext>, CancellationToken)

SchedulePublishExtensions.SchedulePublish<T>(ConsumeContext, TimeSpan, T, CancellationToken)

SchedulingExtensions.GetQuartzNextScheduled(ConsumeContext)

SchedulingExtensions.GetQuartzPreviousSent(ConsumeContext)

SchedulingExtensions.GetQuartzScheduled(ConsumeContext)

SchedulingExtensions.GetQuartzSent(ConsumeContext)

SchedulingExtensions.GetSchedulingTokenId(ConsumeContext)

SendConsumeContextExecuteExtensions.Send(ConsumeContext, Uri, object, Action<SendContext>)

SendConsumeContextExecuteExtensions.Send(ConsumeContext, Uri, object, Func<SendContext, Task>)

SendConsumeContextExecuteExtensions.Send(ConsumeContext, Uri, object, Type, Action<SendContext>)

SendConsumeContextExecuteExtensions.Send(ConsumeContext, Uri, object, Type, Func<SendContext, Task>)

SendConsumeContextExecuteExtensions.Send<T>(ConsumeContext, Uri, object, Action<SendContext<T>>)

SendConsumeContextExecuteExtensions.Send<T>(ConsumeContext, Uri, object, Func<SendContext<T>, Task>)

SendConsumeContextExecuteExtensions.Send<T>(ConsumeContext, Uri, T, Action<SendContext<T>>)

SendConsumeContextExecuteExtensions.Send<T>(ConsumeContext, Uri, T, Func<SendContext<T>, Task>)

SendConsumeContextExtensions.Send(ConsumeContext, Uri, object)

SendConsumeContextExtensions.Send(ConsumeContext, Uri, object, IPipe<SendContext>)

SendConsumeContextExtensions.Send(ConsumeContext, Uri, object, Type)

SendConsumeContextExtensions.Send(ConsumeContext, Uri, object, Type, IPipe<SendContext>)

SendConsumeContextExtensions.Send<T>(ConsumeContext, Uri, object)

SendConsumeContextExtensions.Send<T>(ConsumeContext, Uri, object, IPipe<SendContext<T>>)

SendConsumeContextExtensions.Send<T>(ConsumeContext, Uri, object, IPipe<SendContext>)

SendConsumeContextExtensions.Send<T>(ConsumeContext, Uri, T)

SendConsumeContextExtensions.Send<T>(ConsumeContext, Uri, T, IPipe<SendContext<T>>)

SendConsumeContextExtensions.Send<T>(ConsumeContext, Uri, T, IPipe<SendContext>)

SendContextExtensions.GetOriginalMessageId(ConsumeContext)

SerializerContextExtensions.GetHeader(ConsumeContext, string, string?)

SerializerContextExtensions.GetHeader<T>(ConsumeContext, string, T?)

SerializerContextExtensions.GetHeader<T>(ConsumeContext, string, T?)

SerializerContextExtensions.ToDictionary<T>(ConsumeContext, T)

SerializerContextExtensions.TryGetHeader<T>(ConsumeContext, string, out T?)

SerializerContextExtensions.TryGetHeader<T>(ConsumeContext, string, out T?)

BatchProduceExtensions.PublishBatch(IPublishEndpoint, IEnumerable<object>, IPipe<PublishContext>, CancellationToken)

BatchProduceExtensions.PublishBatch(IPublishEndpoint, IEnumerable<object>, Action<PublishContext>, CancellationToken)

BatchProduceExtensions.PublishBatch(IPublishEndpoint, IEnumerable<object>, Func<PublishContext, Task>, CancellationToken)

BatchProduceExtensions.PublishBatch(IPublishEndpoint, IEnumerable<object>, CancellationToken)

BatchProduceExtensions.PublishBatch(IPublishEndpoint, IEnumerable<object>, Type, IPipe<PublishContext>, CancellationToken)

BatchProduceExtensions.PublishBatch(IPublishEndpoint, IEnumerable<object>, Type, Action<PublishContext>, CancellationToken)

BatchProduceExtensions.PublishBatch(IPublishEndpoint, IEnumerable<object>, Type, Func<PublishContext, Task>, CancellationToken)

BatchProduceExtensions.PublishBatch(IPublishEndpoint, IEnumerable<object>, Type, CancellationToken)

BatchProduceExtensions.PublishBatch<T>(IPublishEndpoint, IEnumerable<T>, IPipe<PublishContext<T>>, CancellationToken)

BatchProduceExtensions.PublishBatch<T>(IPublishEndpoint, IEnumerable<T>, Action<PublishContext<T>>, CancellationToken)

BatchProduceExtensions.PublishBatch<T>(IPublishEndpoint, IEnumerable<T>, Func<PublishContext<T>, Task>, CancellationToken)

BatchProduceExtensions.PublishBatch<T>(IPublishEndpoint, IEnumerable<T>, CancellationToken)

PublishExecuteExtensions.Publish(IPublishEndpoint, object, Action<PublishContext>, CancellationToken)

PublishExecuteExtensions.Publish(IPublishEndpoint, object, Func<PublishContext, Task>, CancellationToken)

PublishExecuteExtensions.Publish(IPublishEndpoint, object, Type, Action<PublishContext>, CancellationToken)

PublishExecuteExtensions.Publish(IPublishEndpoint, object, Type, Func<PublishContext, Task>, CancellationToken)

PublishExecuteExtensions.Publish<T>(IPublishEndpoint, object, Action<PublishContext<T>>, CancellationToken)

PublishExecuteExtensions.Publish<T>(IPublishEndpoint, object, Func<PublishContext<T>, Task>, CancellationToken)

PublishExecuteExtensions.Publish<T>(IPublishEndpoint, T, Action<PublishContext<T>>, CancellationToken)

PublishExecuteExtensions.Publish<T>(IPublishEndpoint, T, Func<PublishContext<T>, Task>, CancellationToken)

PipeExtensions.GetPayload<TPayload>(PipeContext)

PipeExtensions.GetPayload<TPayload>(PipeContext, TPayload)

PipeExtensions.OneTimeSetup<T>(PipeContext, Func<T, Task>, PayloadFactory<T>)

Properties

ConsumeCompleted

An awaitable task that is completed once the consume context is completed

Task ConsumeCompleted { get; }

Property Value

Task

ReceiveContext

The received message context

ReceiveContext ReceiveContext { get; }

Property Value

ReceiveContext

SerializerContext

The serializer context from message deserialization

SerializerContext SerializerContext { get; }

Property Value

SerializerContext

SupportedMessageTypes

Returns the supported message types from the message

IEnumerable<string> SupportedMessageTypes { get; }

Property Value

IEnumerable<string>

Methods

AddConsumeTask(Task)

Add a task that must complete before the consume is completed

void AddConsumeTask(Task task)

Parameters

task Task

HasMessageType(Type)

Returns true if the specified message type is contained in the serialized message

bool HasMessageType(Type messageType)

Parameters

messageType Type

Returns

bool

NotifyConsumed<T>(ConsumeContext<T>, TimeSpan, string)

Notify that the message has been consumed -- note that this is internal, and should not be called by a consumer.

Task NotifyConsumed<T>(ConsumeContext<T> context, TimeSpan duration, string consumerType) where T : class

Parameters

context ConsumeContext<T>

duration TimeSpan

consumerType string

The consumer type

Returns

Task

Type Parameters

T

NotifyFaulted<T>(ConsumeContext<T>, TimeSpan, string, Exception)

Notify that a message consumer has faulted -- note that this is internal, and should not be called by a consumer

Task NotifyFaulted<T>(ConsumeContext<T> context, TimeSpan duration, string consumerType, Exception exception) where T : class

Parameters

context ConsumeContext<T>

duration TimeSpan

consumerType string

The message consumer type

exception Exception

The exception that occurred

Returns

Task

Type Parameters

T

RespondAsync(object)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync(object message)

Parameters

message object

The message to send

Returns

Task

RespondAsync(object, IPipe<SendContext>)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync(object message, IPipe<SendContext> sendPipe)

Parameters

message object

The message to send

sendPipe IPipe<SendContext>

Returns

Task

RespondAsync(object, Type)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync(object message, Type messageType)

Parameters

message object

The message to send

messageType Type

The message type to send

Returns

Task

RespondAsync(object, Type, IPipe<SendContext>)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync(object message, Type messageType, IPipe<SendContext> sendPipe)

Parameters

message object

The message to send

messageType Type

The message type to send

sendPipe IPipe<SendContext>

Returns

Task

RespondAsync<T>(object)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync<T>(object values) where T : class

Parameters

values object

The values for the message properties

Returns

Task

Type Parameters

T

The type of the message to respond with.

RespondAsync<T>(object, IPipe<SendContext<T>>)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync<T>(object values, IPipe<SendContext<T>> sendPipe) where T : class

Parameters

values object

The values for the message properties

sendPipe IPipe<SendContext<T>>

Returns

Task

Type Parameters

T

The type of the message to respond with.

RespondAsync<T>(object, IPipe<SendContext>)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync<T>(object values, IPipe<SendContext> sendPipe) where T : class

Parameters

values object

The values for the message properties

sendPipe IPipe<SendContext>

Returns

Task

Type Parameters

T

The type of the message to respond with.

RespondAsync<T>(T)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync<T>(T message) where T : class

Parameters

message T

The message to send in response

Returns

Task

Type Parameters

T

The type of the message to respond with.

RespondAsync<T>(T, IPipe<SendContext<T>>)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync<T>(T message, IPipe<SendContext<T>> sendPipe) where T : class

Parameters

message T

The message to send in response

sendPipe IPipe<SendContext<T>>

The pipe used to customize the response send context

Returns

Task

Type Parameters

T

The type of the message to respond with.

RespondAsync<T>(T, IPipe<SendContext>)

Responds to the current message immediately, returning the Task for the sending message. The caller may choose to await the response to ensure it was sent, or allow the framework to wait for it (which will happen automatically before the message is acknowledged)

Task RespondAsync<T>(T message, IPipe<SendContext> sendPipe) where T : class

Parameters

message T

The message to send in response

sendPipe IPipe<SendContext>

The pipe used to customize the response send context

Returns

Task

Type Parameters

T

The type of the message to respond with.

Respond<T>(T)

Adds a response to the message being consumed, which will be sent once the consumer has completed. The message is not acknowledged until the response is acknowledged.

void Respond<T>(T message) where T : class

Parameters

message T

The message to send in response

Type Parameters

T

The type of the message to respond with.

TryGetMessage<T>(out ConsumeContext<T>?)

Returns the specified message type if available, otherwise returns false

bool TryGetMessage<T>(out ConsumeContext<T>? consumeContext) where T : class

Parameters

consumeContext ConsumeContext<T>

Returns

bool

Type Parameters

T