Class OutboundQueueProducer

Produces to an endpoint.

Inheritance

object

Producer

Producer<TransactionalOutboxBroker, IProducerEndpoint>

OutboundQueueProducer

Implements

IProducer

Inherited Members

Producer<TransactionalOutboxBroker, IProducerEndpoint>.Broker

Producer<TransactionalOutboxBroker, IProducerEndpoint>.Endpoint

Producer.Id

Producer.Broker

Producer.Endpoint

Producer.IsConnecting

Producer.IsConnected

Producer.ConnectAsync()

Producer.DisconnectAsync()

Producer.Produce(object, IReadOnlyCollection<MessageHeader>)

Producer.Produce(IOutboundEnvelope)

Producer.Produce(object, IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.Produce(IOutboundEnvelope, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.RawProduce(byte[], IReadOnlyCollection<MessageHeader>)

Producer.RawProduce(Stream, IReadOnlyCollection<MessageHeader>)

Producer.RawProduce(string, byte[], IReadOnlyCollection<MessageHeader>)

Producer.RawProduce(string, Stream, IReadOnlyCollection<MessageHeader>)

Producer.RawProduce(byte[], IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.RawProduce(Stream, IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.RawProduce(string, byte[], IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.RawProduce(string, Stream, IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.ProduceAsync(object, IReadOnlyCollection<MessageHeader>)

Producer.ProduceAsync(IOutboundEnvelope)

Producer.ProduceAsync(object, IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.ProduceAsync(IOutboundEnvelope, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.RawProduceAsync(byte[], IReadOnlyCollection<MessageHeader>)

Producer.RawProduceAsync(Stream, IReadOnlyCollection<MessageHeader>)

Producer.RawProduceAsync(string, byte[], IReadOnlyCollection<MessageHeader>)

Producer.RawProduceAsync(string, Stream, IReadOnlyCollection<MessageHeader>)

Producer.RawProduceAsync(byte[], IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.RawProduceAsync(Stream, IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.RawProduceAsync(string, byte[], IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.RawProduceAsync(string, Stream, IReadOnlyCollection<MessageHeader>, Action<IBrokerMessageIdentifier>, Action<Exception>)

Producer.ConnectCoreAsync()

Producer.DisconnectCoreAsync()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Silverback.Messaging.Outbound.Routing

Assembly: Silverback.Integration.dll

Syntax

public class OutboundQueueProducer : Producer<TransactionalOutboxBroker, IProducerEndpoint>, IProducer

Constructors

| Improve this doc View source

OutboundQueueProducer(IOutboxWriter, TransactionalOutboxBroker, IProducerEndpoint, IBrokerBehaviorsProvider<IProducerBehavior>, IServiceProvider, IOutboundLogger<Producer>)

Initializes a new instance of the OutboundQueueProducer class.

Declaration

public OutboundQueueProducer(IOutboxWriter queueWriter, TransactionalOutboxBroker broker, IProducerEndpoint endpoint, IBrokerBehaviorsProvider<IProducerBehavior> behaviorsProvider, IServiceProvider serviceProvider, IOutboundLogger<Producer> logger)

Parameters

Type	Name	Description
IOutboxWriter	queueWriter	The IOutboxWriter to be used to write to the queue.
TransactionalOutboxBroker	broker	The IBroker that instantiated this producer.
IProducerEndpoint	endpoint	The endpoint to produce to.
IBrokerBehaviorsProvider<IProducerBehavior>	behaviorsProvider	The IBrokerBehaviorsProvider<TBehavior>.
IServiceProvider	serviceProvider	The IServiceProvider to be used to resolve the needed services.
IOutboundLogger<Producer>	logger	The IOutboundLogger<TCategoryName>.

Methods

| Improve this doc View source

ProduceCore(object?, byte[]?, IReadOnlyCollection<MessageHeader>?, string)

Publishes the specified message and returns its identifier.

Declaration

protected override IBrokerMessageIdentifier ProduceCore(object? message, byte[]? messageBytes, IReadOnlyCollection<MessageHeader>? headers, string actualEndpointName)

Parameters

Type	Name	Description
object	message	The message to be delivered before serialization. This might be null if RawProduce(byte[]?, IReadOnlyCollection<MessageHeader>?), RawProduce(Stream?, IReadOnlyCollection<MessageHeader>?), RawProduceAsync(byte[]?, IReadOnlyCollection<MessageHeader>?) or RawProduceAsync(Stream?, IReadOnlyCollection<MessageHeader>?) have been used to produce.
byte[]	messageBytes	The actual serialized message to be delivered.
IReadOnlyCollection<MessageHeader>	headers	The message headers.
string	actualEndpointName	The actual endpoint to produce to.

Returns

Type	Description
IBrokerMessageIdentifier	The message identifier assigned by the broker (the Kafka offset or similar).

Overrides

Producer.ProduceCore(object?, byte[]?, IReadOnlyCollection<MessageHeader>?, string)

| Improve this doc View source

ProduceCore(object?, byte[]?, IReadOnlyCollection<MessageHeader>?, string, Action<IBrokerMessageIdentifier?>, Action<Exception>)

Publishes the specified message and returns its identifier.

Declaration

protected override void ProduceCore(object? message, byte[]? messageBytes, IReadOnlyCollection<MessageHeader>? headers, string actualEndpointName, Action<IBrokerMessageIdentifier?> onSuccess, Action<Exception> onError)

Parameters

Type	Name	Description
object	message	The message to be delivered before serialization. This might be null if RawProduce(byte[]?, IReadOnlyCollection<MessageHeader>?), RawProduce(Stream?, IReadOnlyCollection<MessageHeader>?), RawProduceAsync(byte[]?, IReadOnlyCollection<MessageHeader>?) or RawProduceAsync(Stream?, IReadOnlyCollection<MessageHeader>?) have been used to produce.
byte[]	messageBytes	The actual serialized message to be delivered.
IReadOnlyCollection<MessageHeader>	headers	The message headers.
string	actualEndpointName	The actual endpoint to produce to.
Action<IBrokerMessageIdentifier>	onSuccess	The callback to be invoked when the message is successfully produced.
Action<Exception>	onError	The callback to be invoked when the produce fails.

Overrides

Producer.ProduceCore(object?, byte[]?, IReadOnlyCollection<MessageHeader>?, string, Action<IBrokerMessageIdentifier?>, Action<Exception>)

Remarks

In this implementation the message is synchronously enqueued but produced asynchronously. The callbacks are called when the message is actually produced (or the produce failed).

| Improve this doc View source

ProduceCore(object?, Stream?, IReadOnlyCollection<MessageHeader>?, string)

Publishes the specified message and returns its identifier.

Declaration

protected override IBrokerMessageIdentifier ProduceCore(object? message, Stream? messageStream, IReadOnlyCollection<MessageHeader>? headers, string actualEndpointName)

Parameters

Type	Name	Description
object	message	The message to be delivered before serialization. This might be null if RawProduce(byte[]?, IReadOnlyCollection<MessageHeader>?), RawProduce(Stream?, IReadOnlyCollection<MessageHeader>?), RawProduceAsync(byte[]?, IReadOnlyCollection<MessageHeader>?) or RawProduceAsync(Stream?, IReadOnlyCollection<MessageHeader>?) have been used to produce.
Stream	messageStream	The actual serialized message to be delivered.
IReadOnlyCollection<MessageHeader>	headers	The message headers.
string	actualEndpointName	The actual endpoint to produce to.

Returns

Type	Description
IBrokerMessageIdentifier	The message identifier assigned by the broker (the Kafka offset or similar).

Overrides

Producer.ProduceCore(object?, Stream?, IReadOnlyCollection<MessageHeader>?, string)

| Improve this doc View source

ProduceCore(object?, Stream?, IReadOnlyCollection<MessageHeader>?, string, Action<IBrokerMessageIdentifier?>, Action<Exception>)

Publishes the specified message and returns its identifier.

Declaration

protected override void ProduceCore(object? message, Stream? messageStream, IReadOnlyCollection<MessageHeader>? headers, string actualEndpointName, Action<IBrokerMessageIdentifier?> onSuccess, Action<Exception> onError)

Parameters

Type	Name	Description
object	message	The message to be delivered before serialization. This might be null if RawProduce(byte[]?, IReadOnlyCollection<MessageHeader>?), RawProduce(Stream?, IReadOnlyCollection<MessageHeader>?), RawProduceAsync(byte[]?, IReadOnlyCollection<MessageHeader>?) or RawProduceAsync(Stream?, IReadOnlyCollection<MessageHeader>?) have been used to produce.
Stream	messageStream	The message to be delivered.
IReadOnlyCollection<MessageHeader>	headers	The message headers.
string	actualEndpointName	The actual endpoint to produce to.
Action<IBrokerMessageIdentifier>	onSuccess	The callback to be invoked when the message is successfully produced.
Action<Exception>	onError	The callback to be invoked when the produce fails.

Overrides

Producer.ProduceCore(object?, Stream?, IReadOnlyCollection<MessageHeader>?, string, Action<IBrokerMessageIdentifier?>, Action<Exception>)

Remarks

In this implementation the message is synchronously enqueued but produced asynchronously. The callbacks are called when the message is actually produced (or the produce failed).

| Improve this doc View source

ProduceCoreAsync(object?, byte[]?, IReadOnlyCollection<MessageHeader>?, string)

Publishes the specified message and returns its identifier.

Declaration

protected override Task<IBrokerMessageIdentifier?> ProduceCoreAsync(object? message, byte[]? messageBytes, IReadOnlyCollection<MessageHeader>? headers, string actualEndpointName)

Parameters

Type	Name	Description
object	message	The message to be delivered before serialization. This might be null if RawProduce(byte[]?, IReadOnlyCollection<MessageHeader>?), RawProduce(Stream?, IReadOnlyCollection<MessageHeader>?), RawProduceAsync(byte[]?, IReadOnlyCollection<MessageHeader>?) or RawProduceAsync(Stream?, IReadOnlyCollection<MessageHeader>?) have been used to produce.
byte[]	messageBytes	The actual serialized message to be delivered.
IReadOnlyCollection<MessageHeader>	headers	The message headers.
string	actualEndpointName	The actual endpoint to produce to.

Returns

Type	Description
Task<IBrokerMessageIdentifier>	A Task<TResult> representing the asynchronous operation. The task result contains the message identifier assigned by the broker (the Kafka offset or similar).

Overrides

Producer.ProduceCoreAsync(object?, byte[]?, IReadOnlyCollection<MessageHeader>?, string)

| Improve this doc View source

ProduceCoreAsync(object?, byte[]?, IReadOnlyCollection<MessageHeader>?, string, Action<IBrokerMessageIdentifier?>, Action<Exception>)

Publishes the specified message and returns its identifier.

Declaration

protected override Task ProduceCoreAsync(object? message, byte[]? messageBytes, IReadOnlyCollection<MessageHeader>? headers, string actualEndpointName, Action<IBrokerMessageIdentifier?> onSuccess, Action<Exception> onError)

Parameters

Type	Name	Description
object	message	The message to be delivered before serialization. This might be null if RawProduce(byte[]?, IReadOnlyCollection<MessageHeader>?), RawProduce(Stream?, IReadOnlyCollection<MessageHeader>?), RawProduceAsync(byte[]?, IReadOnlyCollection<MessageHeader>?) or RawProduceAsync(Stream?, IReadOnlyCollection<MessageHeader>?) have been used to produce.
byte[]	messageBytes	The actual serialized message to be delivered.
IReadOnlyCollection<MessageHeader>	headers	The message headers.
string	actualEndpointName	The actual endpoint to produce to.
Action<IBrokerMessageIdentifier>	onSuccess	The callback to be invoked when the message is successfully produced.
Action<Exception>	onError	The callback to be invoked when the produce fails.

Returns

Type	Description
Task	A Task representing the asynchronous operation. The Task will complete as soon as the message is enqueued.

Overrides

Producer.ProduceCoreAsync(object?, byte[]?, IReadOnlyCollection<MessageHeader>?, string, Action<IBrokerMessageIdentifier?>, Action<Exception>)

Remarks

The returned Task completes when the message is enqueued while the callbacks are called when the message is actually produced (or the produce failed).

| Improve this doc View source

ProduceCoreAsync(object?, Stream?, IReadOnlyCollection<MessageHeader>?, string)

Publishes the specified message and returns its identifier.

Declaration

protected override Task<IBrokerMessageIdentifier?> ProduceCoreAsync(object? message, Stream? messageStream, IReadOnlyCollection<MessageHeader>? headers, string actualEndpointName)

Parameters

Type	Name	Description
object	message	The message to be delivered before serialization. This might be null if RawProduce(byte[]?, IReadOnlyCollection<MessageHeader>?), RawProduce(Stream?, IReadOnlyCollection<MessageHeader>?), RawProduceAsync(byte[]?, IReadOnlyCollection<MessageHeader>?) or RawProduceAsync(Stream?, IReadOnlyCollection<MessageHeader>?) have been used to produce.
Stream	messageStream	The message to be delivered.
IReadOnlyCollection<MessageHeader>	headers	The message headers.
string	actualEndpointName	The actual endpoint to produce to.

Returns

Type	Description
Task<IBrokerMessageIdentifier>	A Task<TResult> representing the asynchronous operation. The task result contains the message identifier assigned by the broker (the Kafka offset or similar).

Overrides

Producer.ProduceCoreAsync(object?, Stream?, IReadOnlyCollection<MessageHeader>?, string)

| Improve this doc View source

ProduceCoreAsync(object?, Stream?, IReadOnlyCollection<MessageHeader>?, string, Action<IBrokerMessageIdentifier?>, Action<Exception>)

Publishes the specified message and returns its identifier.

Declaration

protected override Task ProduceCoreAsync(object? message, Stream? messageStream, IReadOnlyCollection<MessageHeader>? headers, string actualEndpointName, Action<IBrokerMessageIdentifier?> onSuccess, Action<Exception> onError)

Parameters

Type	Name	Description
object	message	The message to be delivered before serialization. This might be null if RawProduce(byte[]?, IReadOnlyCollection<MessageHeader>?), RawProduce(Stream?, IReadOnlyCollection<MessageHeader>?), RawProduceAsync(byte[]?, IReadOnlyCollection<MessageHeader>?) or RawProduceAsync(Stream?, IReadOnlyCollection<MessageHeader>?) have been used to produce.
Stream	messageStream	The message to be delivered.
IReadOnlyCollection<MessageHeader>	headers	The message headers.
string	actualEndpointName	The actual endpoint to produce to.
Action<IBrokerMessageIdentifier>	onSuccess	The callback to be invoked when the message is successfully produced.
Action<Exception>	onError	The callback to be invoked when the produce fails.

Returns

Type	Description
Task	A Task representing the asynchronous operation. The Task will complete as soon as the message is enqueued.

Overrides

Producer.ProduceCoreAsync(object?, Stream?, IReadOnlyCollection<MessageHeader>?, string, Action<IBrokerMessageIdentifier?>, Action<Exception>)

Remarks

The returned Task completes when the message is enqueued while the callbacks are called when the message is actually produced (or the produce failed).

Implements

IProducer