Class PublishEndpoint

Namespace

MassTransit.Transports

Assembly

MassTransit.Abstractions.dll

The publish endpoint delivers messages to the topic/exchange/whatever based upon the publish topology of the broker, by message type.

public class PublishEndpoint : IPublishEndpoint, IPublishObserverConnector

Inheritance

object

PublishEndpoint

Implements

IPublishEndpoint

IPublishObserverConnector

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

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)

Constructors

PublishEndpoint(IPublishEndpointProvider)

public PublishEndpoint(IPublishEndpointProvider provider)

Parameters

provider IPublishEndpointProvider

Properties

PublishEndpointProvider

protected IPublishEndpointProvider PublishEndpointProvider { get; set; }

Property Value

IPublishEndpointProvider

Methods

ConnectPublishObserver(IPublishObserver)

public ConnectHandle ConnectPublishObserver(IPublishObserver observer)

Parameters

observer IPublishObserver

Returns

ConnectHandle

GetPublishSendEndpoint<T>()

protected virtual Task<ISendEndpoint> GetPublishSendEndpoint<T>() where T : class

Returns

Task<ISendEndpoint>

Type Parameters

T

Publish(object, IPipe<PublishContext>, CancellationToken)

Publishes an object as a message, using the message type specified. If the object cannot be cast to the specified message type, an exception will be thrown.

public Task Publish(object message, IPipe<PublishContext> publishPipe, CancellationToken cancellationToken)

Parameters

message object

The message object

publishPipe IPipe<PublishContext>

cancellationToken CancellationToken

Returns

Task

Publish(object, CancellationToken)

Publishes an object as a message, using the message type specified. If the object cannot be cast to the specified message type, an exception will be thrown.

public Task Publish(object message, CancellationToken cancellationToken)

Parameters

message object

The message object

cancellationToken CancellationToken

Returns

Task

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

Publishes an object as a message, using the message type specified. If the object cannot be cast to the specified message type, an exception will be thrown.

public Task Publish(object message, Type messageType, IPipe<PublishContext> publishPipe, CancellationToken cancellationToken)

Parameters

message object

The message object

messageType Type

The type of the message (use message.GetType() if desired)

publishPipe IPipe<PublishContext>

cancellationToken CancellationToken

Returns

Task

Publish(object, Type, CancellationToken)

Publishes an object as a message, using the message type specified. If the object cannot be cast to the specified message type, an exception will be thrown.

public Task Publish(object message, Type messageType, CancellationToken cancellationToken)

Parameters

message object

The message object

messageType Type

The type of the message (use message.GetType() if desired)

cancellationToken CancellationToken

Returns

Task

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

Publish<T>(T, CancellationToken): this overload further takes an action; it allows you to set PublishContext meta-data. Also Publish<T>(T, CancellationToken).

public Task Publish<T>(object values, IPipe<PublishContext<T>> publishPipe, CancellationToken cancellationToken) where T : class

Parameters

values object

The dictionary of values to become hydrated and published under the type of the interface.

publishPipe IPipe<PublishContext<T>>

cancellationToken CancellationToken

Returns

Task

Type Parameters

T

The type of the message to publish

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

Publish<T>(T, CancellationToken): this overload further takes an action; it allows you to set PublishContext meta-data. Also Publish<T>(T, CancellationToken).

public Task Publish<T>(object values, IPipe<PublishContext> publishPipe, CancellationToken cancellationToken) where T : class

Parameters

values object

The dictionary of values to become hydrated and published under the type of the interface.

publishPipe IPipe<PublishContext>

cancellationToken CancellationToken

Returns

Task

Type Parameters

T

The type of the message to publish

Publish<T>(object, CancellationToken)

Publish<T>(T, CancellationToken): this is a "dynamically" typed overload - give it an interface as its type parameter, and a loosely typed dictionary of values and the MassTransit underlying infrastructure will populate an object instance with the passed values. It actually does this with DynamicProxy in the background.

public Task Publish<T>(object values, CancellationToken cancellationToken) where T : class

Parameters

values object

The dictionary of values to place in the object instance to implement the interface.

cancellationToken CancellationToken

Returns

Task

Type Parameters

T

The type of the interface or non-sealed class with all-virtual members.

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

Publishes a message to all subscribed consumers for the message type as specified by the generic parameter. The second parameter allows the caller to customize the outgoing publish context and set things like headers on the message.

Read up on publishing: http://readthedocs.org/docs/masstransit/en/latest/overview/publishing.html

public Task Publish<T>(T message, IPipe<PublishContext<T>> publishPipe, CancellationToken cancellationToken) where T : class

Parameters

message T

The messages to be published

publishPipe IPipe<PublishContext<T>>

cancellationToken CancellationToken

Returns

Task

Type Parameters

T

The type of the message

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

Publishes a message to all subscribed consumers for the message type as specified by the generic parameter. The second parameter allows the caller to customize the outgoing publish context and set things like headers on the message.

Read up on publishing: http://readthedocs.org/docs/masstransit/en/latest/overview/publishing.html

public Task Publish<T>(T message, IPipe<PublishContext> publishPipe, CancellationToken cancellationToken) where T : class

Parameters

message T

The messages to be published

publishPipe IPipe<PublishContext>

cancellationToken CancellationToken

Returns

Task

Type Parameters

T

The type of the message

Publish<T>(T, CancellationToken)

Publishes a message to all subscribed consumers for the message type as specified by the generic parameter. The second parameter allows the caller to customize the outgoing publish context and set things like headers on the message.

Read up on publishing: http://readthedocs.org/docs/masstransit/en/latest/overview/publishing.html

public Task Publish<T>(T message, CancellationToken cancellationToken) where T : class

Parameters

message T

The messages to be published

cancellationToken CancellationToken

Returns

Task

Type Parameters

T

The type of the message