Class AbstractMessageReceivingTemplate<D>

Namespace

Steeltoe.Messaging.Core

Assembly

Steeltoe.Messaging.MessagingBase.dll

public abstract class AbstractMessageReceivingTemplate<D> : AbstractMessageSendingTemplate<D>, IMessageSendingOperations<D>, IMessageReceivingOperations<D>

Type Parameters

D

Inheritance

object

AbstractMessageSendingTemplate<D>

AbstractMessageReceivingTemplate<D>

Implements

IMessageSendingOperations<D>

IMessageReceivingOperations<D>

Derived

AbstractMessagingTemplate<D>

Inherited Members

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()

Properties

DefaultReceiveDestination

public virtual D DefaultReceiveDestination { get; set; }

Property Value

D

RequiredDefaultReceiveDestination

protected virtual D RequiredDefaultReceiveDestination { get; }

Property Value

D

ThrowReceivedExceptions

public virtual bool ThrowReceivedExceptions { get; set; }

Property Value

bool

Methods

DoConvert<T>(IMessage)

protected virtual T DoConvert<T>(IMessage message)

Parameters

message IMessage

Returns

T

Type Parameters

T

DoReceive(D)

protected abstract IMessage DoReceive(D destination)

Parameters

destination D

Returns

IMessage

DoReceiveAsync(D, CancellationToken)

protected abstract Task<IMessage> DoReceiveAsync(D destination, CancellationToken cancellationToken)

Parameters

destination D

cancellationToken CancellationToken

Returns

Task<IMessage>

Receive()

Receive a message from a default destination

public virtual IMessage Receive()

Returns

IMessage

the received message; or null

Receive(D)

Receive a message from the given destination

public virtual IMessage Receive(D destination)

Parameters

destination D

the target destination

Returns

IMessage

the received message; or null

ReceiveAndConvertAsync<T>(CancellationToken)

Receive a message from a default destination and convert its payload to the specified target type.

public virtual Task<T> ReceiveAndConvertAsync<T>(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<T>

a task to signal completion

Type Parameters

T

the type of the payload

ReceiveAndConvertAsync<T>(D, CancellationToken)

Receive a message from the given destination and convert its payload to the specified target type.

public virtual Task<T> ReceiveAndConvertAsync<T>(D destination, CancellationToken cancellationToken = default)

Parameters

destination D

the target destination

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<T>

a task to signal completion

Type Parameters

T

the type of the payload

ReceiveAndConvert<T>()

Receive a message from a default destination and convert its payload to the specified target type.

public virtual T ReceiveAndConvert<T>()

Returns

T

the received message; or null

Type Parameters

T

the type of the payload

ReceiveAndConvert<T>(D)

Receive a message from the given destination and convert its payload to the specified target type.

public virtual T ReceiveAndConvert<T>(D destination)

Parameters

destination D

the target destination

Returns

T

the received message; or null

Type Parameters

T

the type of the payload

ReceiveAsync(CancellationToken)

Receive a message from a default destination

public virtual Task<IMessage> ReceiveAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<IMessage>

a task to signal completion

ReceiveAsync(D, CancellationToken)

Receive a message from the given destination

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

Parameters

destination D

the target destination

cancellationToken CancellationToken

token used to signal cancelation

Returns

Task<IMessage>

a task to signal completion