Class AbstractMessagingTemplate<D>

Namespace

Steeltoe.Messaging.Core

Assembly

Steeltoe.Messaging.MessagingBase.dll

public abstract class AbstractMessagingTemplate<D> : AbstractMessageReceivingTemplate<D>, IMessageSendingOperations<D>, IMessageReceivingOperations<D>, IMessageRequestReplyOperations<D>

Type Parameters

D

Inheritance

object

AbstractMessageSendingTemplate<D>

AbstractMessageReceivingTemplate<D>

AbstractMessagingTemplate<D>

Implements

IMessageSendingOperations<D>

IMessageReceivingOperations<D>

IMessageRequestReplyOperations<D>

Derived

AbstractDestinationResolvingMessagingTemplate<D>

RabbitTemplate

Inherited Members

AbstractMessageReceivingTemplate<D>.DefaultReceiveDestination

AbstractMessageReceivingTemplate<D>.ThrowReceivedExceptions

AbstractMessageReceivingTemplate<D>.ReceiveAsync(CancellationToken)

AbstractMessageReceivingTemplate<D>.ReceiveAsync(D, CancellationToken)

AbstractMessageReceivingTemplate<D>.ReceiveAndConvertAsync<T>(CancellationToken)

AbstractMessageReceivingTemplate<D>.ReceiveAndConvertAsync<T>(D, CancellationToken)

AbstractMessageReceivingTemplate<D>.Receive()

AbstractMessageReceivingTemplate<D>.Receive(D)

AbstractMessageReceivingTemplate<D>.ReceiveAndConvert<T>()

AbstractMessageReceivingTemplate<D>.ReceiveAndConvert<T>(D)

AbstractMessageReceivingTemplate<D>.RequiredDefaultReceiveDestination

AbstractMessageReceivingTemplate<D>.DoReceiveAsync(D, CancellationToken)

AbstractMessageReceivingTemplate<D>.DoReceive(D)

AbstractMessageReceivingTemplate<D>.DoConvert<T>(IMessage)

AbstractMessageSendingTemplate<D>.CONVERSION_HINT_HEADER

AbstractMessageSendingTemplate<D>.DefaultSendDestination

AbstractMessageSendingTemplate<D>.MessageConverter

AbstractMessageSendingTemplate<D>.ConvertAndSendAsync(object, CancellationToken)

AbstractMessageSendingTemplate<D>.ConvertAndSendAsync(D, object, CancellationToken)

AbstractMessageSendingTemplate<D>.ConvertAndSendAsync(D, object, IDictionary<string, object>, CancellationToken)

AbstractMessageSendingTemplate<D>.ConvertAndSendAsync(object, IMessagePostProcessor, CancellationToken)

AbstractMessageSendingTemplate<D>.ConvertAndSendAsync(D, object, IMessagePostProcessor, CancellationToken)

AbstractMessageSendingTemplate<D>.ConvertAndSendAsync(D, object, IDictionary<string, object>, IMessagePostProcessor, CancellationToken)

AbstractMessageSendingTemplate<D>.SendAsync(IMessage, CancellationToken)

AbstractMessageSendingTemplate<D>.SendAsync(D, IMessage, CancellationToken)

AbstractMessageSendingTemplate<D>.ConvertAndSend(object)

AbstractMessageSendingTemplate<D>.ConvertAndSend(D, object)

AbstractMessageSendingTemplate<D>.ConvertAndSend(D, object, IDictionary<string, object>)

AbstractMessageSendingTemplate<D>.ConvertAndSend(object, IMessagePostProcessor)

AbstractMessageSendingTemplate<D>.ConvertAndSend(D, object, IMessagePostProcessor)

AbstractMessageSendingTemplate<D>.ConvertAndSend(D, object, IDictionary<string, object>, IMessagePostProcessor)

AbstractMessageSendingTemplate<D>.Send(IMessage)

AbstractMessageSendingTemplate<D>.Send(D, IMessage)

AbstractMessageSendingTemplate<D>.DoSendAsync(D, IMessage, CancellationToken)

AbstractMessageSendingTemplate<D>.DoSend(D, IMessage)

AbstractMessageSendingTemplate<D>.RequiredDefaultSendDestination

AbstractMessageSendingTemplate<D>.DoConvert(object, IDictionary<string, object>, IMessagePostProcessor)

AbstractMessageSendingTemplate<D>.ProcessHeadersToSend(IDictionary<string, object>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ConvertSendAndReceiveAsync<T>(object, IMessagePostProcessor, CancellationToken)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to a default destination after applying the post processor, receive the reply and convert its body to the specified target type.

public virtual Task<T> ConvertSendAndReceiveAsync<T>(object request, IMessagePostProcessor requestPostProcessor, CancellationToken cancellationToken = default)

Parameters

request object

payload for the request message to send

requestPostProcessor IMessagePostProcessor

the post processor to apply

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<T>

a task to signal completion

Type Parameters

T

the target type of the reply

ConvertSendAndReceiveAsync<T>(object, CancellationToken)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to a default destination, receive the reply and convert its body to the specified target type.

public virtual Task<T> ConvertSendAndReceiveAsync<T>(object request, CancellationToken cancellationToken = default)

Parameters

request object

payload for the request message to send

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<T>

a task to signal completion

Type Parameters

T

the target type of the payload

ConvertSendAndReceiveAsync<T>(D, object, IMessagePostProcessor, CancellationToken)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to the specified destination after applying the post processor, receive the reply and convert its body to the specified target type.

public virtual Task<T> ConvertSendAndReceiveAsync<T>(D destination, object request, IMessagePostProcessor requestPostProcessor, CancellationToken cancellationToken = default)

Parameters

destination D

the target destination

request object

payload for the request message to send

requestPostProcessor IMessagePostProcessor

the post processor to apply

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<T>

a task to signal completion

Type Parameters

T

the target type of the reply

ConvertSendAndReceiveAsync<T>(D, object, IDictionary<string, object>, IMessagePostProcessor, CancellationToken)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to the specified destination after applying the post processor, with the specified headers, receive the reply and convert its body to the specified target type.

public virtual Task<T> ConvertSendAndReceiveAsync<T>(D destination, object request, IDictionary<string, object> headers, IMessagePostProcessor requestPostProcessor, CancellationToken cancellationToken = default)

Parameters

destination D

the target destination

request object

payload for the request message to send

headers IDictionary<string, object>

the headers to send

requestPostProcessor IMessagePostProcessor

the post processor to apply

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<T>

a task to signal completion

Type Parameters

T

the target type of the reply

ConvertSendAndReceiveAsync<T>(D, object, IDictionary<string, object>, CancellationToken)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to a specified destination with the given headers, receive the reply and convert its body to the specified target type.

public virtual Task<T> ConvertSendAndReceiveAsync<T>(D destination, object request, IDictionary<string, object> headers, CancellationToken cancellationToken = default)

Parameters

destination D

the target destination

request object

payload for the request message to send

headers IDictionary<string, object>

the headers to send

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<T>

a task to signal completion

Type Parameters

T

the target type of the payload

ConvertSendAndReceiveAsync<T>(D, object, CancellationToken)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to a specified destination, receive the reply and convert its body to the specified target type.

public virtual Task<T> ConvertSendAndReceiveAsync<T>(D destination, object request, CancellationToken cancellationToken = default)

Parameters

destination D

the target destination

request object

payload for the request message to send

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<T>

a task to signal completion

Type Parameters

T

the target type of the payload

ConvertSendAndReceive<T>(object)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to a default destination, receive the reply and convert its body to the specified target type.

public virtual T ConvertSendAndReceive<T>(object request)

Parameters

request object

payload for the request message to send

Returns

T

the receieved message; or null

Type Parameters

T

the target type of the payload

ConvertSendAndReceive<T>(object, IMessagePostProcessor)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to a default destination after applying the post processor, receive the reply and convert its body to the specified target type.

public virtual T ConvertSendAndReceive<T>(object request, IMessagePostProcessor requestPostProcessor)

Parameters

request object

payload for the request message to send

requestPostProcessor IMessagePostProcessor

the post processor to apply

Returns

T

the receieved message; or null

Type Parameters

T

the target type of the reply

ConvertSendAndReceive<T>(D, object)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to a specified destination, receive the reply and convert its body to the specified target type.

public virtual T ConvertSendAndReceive<T>(D destination, object request)

Parameters

destination D

the target destination

request object

payload for the request message to send

Returns

T

the receieved message; or null

Type Parameters

T

the target type of the payload

ConvertSendAndReceive<T>(D, object, IMessagePostProcessor)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to the specified destination after applying the post processor, receive the reply and convert its body to the specified target type.

public virtual T ConvertSendAndReceive<T>(D destination, object request, IMessagePostProcessor requestPostProcessor)

Parameters

destination D

the target destination

request object

payload for the request message to send

requestPostProcessor IMessagePostProcessor

the post processor to apply

Returns

T

the receieved message; or null

Type Parameters

T

the target type of the reply

ConvertSendAndReceive<T>(D, object, IDictionary<string, object>)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to a specified destination with the given headers, receive the reply and convert its body to the specified target type.

public virtual T ConvertSendAndReceive<T>(D destination, object request, IDictionary<string, object> headers)

Parameters

destination D

the target destination

request object

payload for the request message to send

headers IDictionary<string, object>

the headers to send

Returns

T

the receieved message; or null

Type Parameters

T

the target type of the payload

ConvertSendAndReceive<T>(D, object, IDictionary<string, object>, IMessagePostProcessor)

Convert the given request object to serialized form, possibly using a message converter, send it as a message to the specified destination after applying the post processor, with the specified headers, receive the reply and convert its body to the specified target type.

public virtual T ConvertSendAndReceive<T>(D destination, object request, IDictionary<string, object> headers, IMessagePostProcessor requestPostProcessor)

Parameters

destination D

the target destination

request object

payload for the request message to send

headers IDictionary<string, object>

the headers to send

requestPostProcessor IMessagePostProcessor

the post processor to apply

Returns

T

the receieved message; or null

Type Parameters

T

the target type of the reply

DoSendAndReceive(D, IMessage)

protected abstract IMessage DoSendAndReceive(D destination, IMessage requestMessage)

Parameters

destination D

requestMessage IMessage

Returns

IMessage

DoSendAndReceiveAsync(D, IMessage, CancellationToken)

protected abstract Task<IMessage> DoSendAndReceiveAsync(D destination, IMessage requestMessage, CancellationToken cancellationToken = default)

Parameters

destination D

requestMessage IMessage

cancellationToken CancellationToken

Returns

Task<IMessage>

SendAndReceive(IMessage)

Send a request message and receive the reply from a default destination.

public virtual IMessage SendAndReceive(IMessage requestMessage)

Parameters

requestMessage IMessage

the message to send

Returns

IMessage

the receieved message; or null

SendAndReceive(D, IMessage)

Send a request message and receive the reply from the given destination.

public virtual IMessage SendAndReceive(D destination, IMessage requestMessage)

Parameters

destination D

the target destination

requestMessage IMessage

the message to send

Returns

IMessage

the receieved message; or null

SendAndReceiveAsync(IMessage, CancellationToken)

Send a request message and receive the reply from a default destination.

public virtual Task<IMessage> SendAndReceiveAsync(IMessage requestMessage, CancellationToken cancellationToken = default)

Parameters

requestMessage IMessage

the message to send

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<IMessage>

a task to signal completion

SendAndReceiveAsync(D, IMessage, CancellationToken)

Send a request message and receive the reply from the given destination.

public virtual Task<IMessage> SendAndReceiveAsync(D destination, IMessage requestMessage, CancellationToken cancellationToken = default)

Parameters

destination D

the target destination

requestMessage IMessage

the message to send

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<IMessage>

a task to signal completion