Interface IPublisher

Publishes the messages to the internal bus.

This is the actual mediator that forwards the messages being published to their subscribers.

Namespace: Silverback.Messaging.Publishing

Assembly: Silverback.Core.dll

Syntax

public interface IPublisher

Methods

Publish(Object)

Publishes the specified message to the internal bus. The message will be forwarded to its subscribers and the method will not complete until all subscribers have processed it (unless using Silverback.Integration to produce and consume the message through a message broker).

Declaration

void Publish(object message)

Parameters

Type	Name	Description
System.Object	message	The message to be published.

Publish(Object, Boolean)

Publishes the specified message to the internal bus. The message will be forwarded to its subscribers and the method will not complete until all subscribers have processed it (unless using Silverback.Integration to produce and consume the message through a message broker).

Declaration

void Publish(object message, bool throwIfUnhandled)

Parameters

Type	Name	Description
System.Object	message	The message to be published.
System.Boolean	throwIfUnhandled	A boolean value indicating whether an exception must be thrown if no subscriber is handling the message.

Publish<TResult>(Object)

Publishes the specified message to the internal bus. The message will be forwarded to its subscribers and the method will not complete until all subscribers have processed it (unless using Silverback.Integration to produce and consume the message through a message broker).

Declaration

IReadOnlyCollection<TResult> Publish<TResult>(object message)

Parameters

Type	Name	Description
System.Object	message	The message to be published.

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<TResult>	A collection of TResult, since multiple subscribers could handle the message and return a value.

Type Parameters

Name	Description
TResult	The type of the result that is expected to be returned by the subscribers.

Publish<TResult>(Object, Boolean)

Publishes the specified message to the internal bus. The message will be forwarded to its subscribers and the method will not complete until all subscribers have processed it (unless using Silverback.Integration to produce and consume the message through a message broker).

Declaration

IReadOnlyCollection<TResult> Publish<TResult>(object message, bool throwIfUnhandled)

Parameters

Type	Name	Description
System.Object	message	The message to be published.
System.Boolean	throwIfUnhandled	A boolean value indicating whether an exception must be thrown if no subscriber is handling the message.

Returns

Type	Description
System.Collections.Generic.IReadOnlyCollection<TResult>	A collection of TResult, since multiple subscribers could handle the message and return a value.

Type Parameters

Name	Description
TResult	The type of the result that is expected to be returned by the subscribers.

PublishAsync(Object)

Publishes the specified message to the internal bus. The message will be forwarded to its subscribers and the System.Threading.Tasks.Task will not complete until all subscribers have processed it (unless using Silverback.Integration to produce and consume the message through a message broker).

Declaration

Task PublishAsync(object message)

Parameters

Type	Name	Description
System.Object	message	The message to be published.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

PublishAsync(Object, Boolean)

Publishes the specified message to the internal bus. The message will be forwarded to its subscribers and the System.Threading.Tasks.Task will not complete until all subscribers have processed it (unless using Silverback.Integration to produce and consume the message through a message broker).

Declaration

Task PublishAsync(object message, bool throwIfUnhandled)

Parameters

Type	Name	Description
System.Object	message	The message to be published.
System.Boolean	throwIfUnhandled	A boolean value indicating whether an exception must be thrown if no subscriber is handling the message.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

PublishAsync<TResult>(Object)

Publishes the specified message to the internal bus. The message will be forwarded to its subscribers and the System.Threading.Tasks.Task will not complete until all subscribers have processed it (unless using Silverback.Integration to produce and consume the message through a message broker).

Declaration

Task<IReadOnlyCollection<TResult>> PublishAsync<TResult>(object message)

Parameters

Type	Name	Description
System.Object	message	The message to be published.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<TResult>>	A System.Threading.Tasks.Task<TResult> representing the asynchronous operation. The task result contains a collection of TResult, since multiple subscribers could handle the message and return a value.

Type Parameters

Name	Description
TResult	The type of the result that is expected to be returned by the subscribers.

PublishAsync<TResult>(Object, Boolean)

Publishes the specified message to the internal bus. The message will be forwarded to its subscribers and the System.Threading.Tasks.Task will not complete until all subscribers have processed it (unless using Silverback.Integration to produce and consume the message through a message broker).

Declaration

Task<IReadOnlyCollection<TResult>> PublishAsync<TResult>(object message, bool throwIfUnhandled)

Parameters

Type	Name	Description
System.Object	message	The message to be published.
System.Boolean	throwIfUnhandled	A boolean value indicating whether an exception must be thrown if no subscriber is handling the message.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<TResult>>	A System.Threading.Tasks.Task<TResult> representing the asynchronous operation. The task result contains a collection of TResult, since multiple subscribers could handle the message and return a value.

Type Parameters

Name	Description
TResult	The type of the result that is expected to be returned by the subscribers.