Class CommandPublisherExtensions

Namespace

Silverback.Messaging.Publishing

Assembly

Silverback.Core.Model.dll

Adds the ExecuteCommand(IPublisher, ICommand, bool) and ExecuteCommandAsync(IPublisher, ICommand, CancellationToken) methods to the IPublisher interface.

public static class CommandPublisherExtensions

Inheritance

object

CommandPublisherExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

ExecuteCommand(IPublisher, ICommand, bool)

Executes the specified command forwarding it to its subscribers via the message bus 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).

public static void ExecuteCommand(this IPublisher publisher, ICommand commandMessage, bool throwIfUnhandled = true)

Parameters

publisher IPublisher

The IPublisher.

commandMessage ICommand

The command to be executed.

throwIfUnhandled bool

A boolean value indicating whether an exception must be thrown if no subscriber is handling the message.

ExecuteCommandAsync(IPublisher, ICommand, bool, CancellationToken)

Executes the specified command forwarding it to its subscribers via the message bus 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).

public static Task ExecuteCommandAsync(this IPublisher publisher, ICommand commandMessage, bool throwIfUnhandled, CancellationToken cancellationToken = default)

Parameters

publisher IPublisher

The IPublisher.

commandMessage ICommand

The command to be executed.

throwIfUnhandled bool

A boolean value indicating whether an exception must be thrown if no subscriber is handling the message.

cancellationToken CancellationToken

The CancellationToken that can be used to cancel the operation.

Returns

Task

A Task representing the asynchronous operation.

ExecuteCommandAsync(IPublisher, ICommand, CancellationToken)

Executes the specified command forwarding it to its subscribers via the message bus 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).

public static Task ExecuteCommandAsync(this IPublisher publisher, ICommand commandMessage, CancellationToken cancellationToken = default)

Parameters

publisher IPublisher

The IPublisher.

commandMessage ICommand

The command to be executed.

cancellationToken CancellationToken

The CancellationToken that can be used to cancel the operation.

Returns

Task

A Task representing the asynchronous operation.

ExecuteCommandAsync<TResult>(IPublisher, ICommand<TResult>, bool, CancellationToken)

Executes the specified command forwarding it to its subscribers via the message bus 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).

public static Task<TResult> ExecuteCommandAsync<TResult>(this IPublisher publisher, ICommand<TResult> commandMessage, bool throwIfUnhandled, CancellationToken cancellationToken = default)

Parameters

publisher IPublisher

The IPublisher.

commandMessage ICommand<TResult>

The command to be executed.

throwIfUnhandled bool

A boolean value indicating whether an exception must be thrown if no subscriber is handling the message.

cancellationToken CancellationToken

The CancellationToken that can be used to cancel the operation.

Returns

Task<TResult>

A Task<TResult> representing the asynchronous operation. The Task result contains the command result.

Type Parameters

TResult

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

ExecuteCommandAsync<TResult>(IPublisher, ICommand<TResult>, CancellationToken)

Executes the specified command forwarding it to its subscribers via the message bus 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).

public static Task<TResult> ExecuteCommandAsync<TResult>(this IPublisher publisher, ICommand<TResult> commandMessage, CancellationToken cancellationToken = default)

Parameters

publisher IPublisher

The IPublisher.

commandMessage ICommand<TResult>

The command to be executed.

cancellationToken CancellationToken

The CancellationToken that can be used to cancel the operation.

Returns

Task<TResult>

A Task<TResult> representing the asynchronous operation. The Task result contains the command result.

Type Parameters

TResult

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

ExecuteCommand<TResult>(IPublisher, ICommand<TResult>, bool)

Executes the specified command forwarding it to its subscribers via the message bus 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).

public static TResult ExecuteCommand<TResult>(this IPublisher publisher, ICommand<TResult> commandMessage, bool throwIfUnhandled = true)

Parameters

publisher IPublisher

The IPublisher.

commandMessage ICommand<TResult>

The command to be executed.

throwIfUnhandled bool

A boolean value indicating whether an exception must be thrown if no subscriber is handling the message.

Returns

TResult

The command result.

Type Parameters

TResult

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