Class MessageChannelTemplate

Namespace

Steeltoe.Messaging.Core

Assembly

Steeltoe.Messaging.MessagingBase.dll

[Obsolete("This feature will be removed in the next major version. See https://steeltoe.io/docs/v3/obsolete for details.")]
public class MessageChannelTemplate : AbstractDestinationResolvingMessagingTemplate<IMessageChannel>, IDestinationResolvingMessageSendingOperations<IMessageChannel>, IMessageSendingOperations<IMessageChannel>, IDestinationResolvingMessageReceivingOperations<IMessageChannel>, IMessageReceivingOperations<IMessageChannel>, IDestinationResolvingMessageRequestReplyOperations<IMessageChannel>, IMessageRequestReplyOperations<IMessageChannel>

Inheritance

object

AbstractMessageSendingTemplate<IMessageChannel>

AbstractMessageReceivingTemplate<IMessageChannel>

AbstractMessagingTemplate<IMessageChannel>

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>

MessageChannelTemplate

Implements

IDestinationResolvingMessageSendingOperations<IMessageChannel>

IMessageSendingOperations<IMessageChannel>

IDestinationResolvingMessageReceivingOperations<IMessageChannel>

IMessageReceivingOperations<IMessageChannel>

IDestinationResolvingMessageRequestReplyOperations<IMessageChannel>

IMessageRequestReplyOperations<IMessageChannel>

Derived

MessagingTemplate

Inherited Members

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ApplicationContext

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.DestinationResolver

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertAndSendAsync(string, object, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertAndSendAsync(string, object, IDictionary<string, object>, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertAndSendAsync(string, object, IMessagePostProcessor, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertAndSendAsync(string, object, IDictionary<string, object>, IMessagePostProcessor, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(string, object, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(string, object, IDictionary<string, object>, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(string, object, IMessagePostProcessor, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(string, object, IDictionary<string, object>, IMessagePostProcessor, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ReceiveAsync(string, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ReceiveAndConvertAsync<T>(string, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.SendAsync(string, IMessage, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.SendAndReceiveAsync(string, IMessage, CancellationToken)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertAndSend(string, object)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertAndSend(string, object, IDictionary<string, object>)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertAndSend(string, object, IMessagePostProcessor)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertAndSend(string, object, IDictionary<string, object>, IMessagePostProcessor)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(string, object)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(string, object, IDictionary<string, object>)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(string, object, IMessagePostProcessor)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(string, object, IDictionary<string, object>, IMessagePostProcessor)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.Receive(string)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ReceiveAndConvert<T>(string)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.Send(string, IMessage)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.SendAndReceive(string, IMessage)

AbstractDestinationResolvingMessagingTemplate<IMessageChannel>.ResolveDestination(string)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(object, CancellationToken)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(IMessageChannel, object, CancellationToken)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(IMessageChannel, object, IDictionary<string, object>, CancellationToken)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(object, IMessagePostProcessor, CancellationToken)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(IMessageChannel, object, IMessagePostProcessor, CancellationToken)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceiveAsync<T>(IMessageChannel, object, IDictionary<string, object>, IMessagePostProcessor, CancellationToken)

AbstractMessagingTemplate<IMessageChannel>.SendAndReceiveAsync(IMessage, CancellationToken)

AbstractMessagingTemplate<IMessageChannel>.SendAndReceiveAsync(IMessageChannel, IMessage, CancellationToken)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(object)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(IMessageChannel, object)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(IMessageChannel, object, IDictionary<string, object>)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(object, IMessagePostProcessor)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(IMessageChannel, object, IMessagePostProcessor)

AbstractMessagingTemplate<IMessageChannel>.ConvertSendAndReceive<T>(IMessageChannel, object, IDictionary<string, object>, IMessagePostProcessor)

AbstractMessagingTemplate<IMessageChannel>.SendAndReceive(IMessage)

AbstractMessagingTemplate<IMessageChannel>.SendAndReceive(IMessageChannel, IMessage)

AbstractMessageReceivingTemplate<IMessageChannel>.DefaultReceiveDestination

AbstractMessageReceivingTemplate<IMessageChannel>.ThrowReceivedExceptions

AbstractMessageReceivingTemplate<IMessageChannel>.ReceiveAsync(CancellationToken)

AbstractMessageReceivingTemplate<IMessageChannel>.ReceiveAsync(IMessageChannel, CancellationToken)

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

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

AbstractMessageReceivingTemplate<IMessageChannel>.Receive()

AbstractMessageReceivingTemplate<IMessageChannel>.Receive(IMessageChannel)

AbstractMessageReceivingTemplate<IMessageChannel>.ReceiveAndConvert<T>()

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

AbstractMessageReceivingTemplate<IMessageChannel>.RequiredDefaultReceiveDestination

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

AbstractMessageSendingTemplate<IMessageChannel>.CONVERSION_HINT_HEADER

AbstractMessageSendingTemplate<IMessageChannel>.DefaultSendDestination

AbstractMessageSendingTemplate<IMessageChannel>.MessageConverter

AbstractMessageSendingTemplate<IMessageChannel>.ConvertAndSendAsync(object, CancellationToken)

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

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

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

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

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

AbstractMessageSendingTemplate<IMessageChannel>.SendAsync(IMessage, CancellationToken)

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

AbstractMessageSendingTemplate<IMessageChannel>.ConvertAndSend(object)

AbstractMessageSendingTemplate<IMessageChannel>.ConvertAndSend(IMessageChannel, object)

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

AbstractMessageSendingTemplate<IMessageChannel>.ConvertAndSend(object, IMessagePostProcessor)

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

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

AbstractMessageSendingTemplate<IMessageChannel>.Send(IMessage)

AbstractMessageSendingTemplate<IMessageChannel>.Send(IMessageChannel, IMessage)

AbstractMessageSendingTemplate<IMessageChannel>.RequiredDefaultSendDestination

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

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

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MessageChannelTemplate(ILogger)

public MessageChannelTemplate(ILogger logger = null)

Parameters

logger ILogger

MessageChannelTemplate(IApplicationContext, ILogger)

public MessageChannelTemplate(IApplicationContext context, ILogger logger = null)

Parameters

context IApplicationContext

logger ILogger

Fields

DEFAULT_RECEIVE_TIMEOUT_HEADER

public const string DEFAULT_RECEIVE_TIMEOUT_HEADER = "receiveTimeout"

Field Value

string

DEFAULT_SEND_TIMEOUT_HEADER

public const string DEFAULT_SEND_TIMEOUT_HEADER = "sendTimeout"

Field Value

string

Properties

ReceiveTimeout

public virtual int ReceiveTimeout { get; set; }

Property Value

int

ReceiveTimeoutHeader

public virtual string ReceiveTimeoutHeader { get; set; }

Property Value

string

SendTimeout

public virtual int SendTimeout { get; set; }

Property Value

int

SendTimeoutHeader

public virtual string SendTimeoutHeader { get; set; }

Property Value

string

ThrowExceptionOnLateReply

public virtual bool ThrowExceptionOnLateReply { get; set; }

Property Value

bool

Methods

DoReceive(IMessageChannel)

protected override IMessage DoReceive(IMessageChannel destination)

Parameters

destination IMessageChannel

Returns

IMessage

DoReceive(IMessageChannel, int)

protected IMessage DoReceive(IMessageChannel channel, int timeout)

Parameters

channel IMessageChannel

timeout int

Returns

IMessage

DoReceiveAsync(IMessageChannel, int, CancellationToken)

protected Task<IMessage> DoReceiveAsync(IMessageChannel channel, int timeout, CancellationToken cancellationToken = default)

Parameters

channel IMessageChannel

timeout int

cancellationToken CancellationToken

Returns

Task<IMessage>

DoReceiveAsync(IMessageChannel, CancellationToken)

protected override Task<IMessage> DoReceiveAsync(IMessageChannel destination, CancellationToken cancellationToken)

Parameters

destination IMessageChannel

cancellationToken CancellationToken

Returns

Task<IMessage>

DoReceiveInternalAsync(IMessageChannel, int, CancellationToken)

protected Task<IMessage> DoReceiveInternalAsync(IMessageChannel channel, int timeout, CancellationToken cancellationToken = default)

Parameters

channel IMessageChannel

timeout int

cancellationToken CancellationToken

Returns

Task<IMessage>

DoSend(IMessageChannel, IMessage)

protected override void DoSend(IMessageChannel destination, IMessage message)

Parameters

destination IMessageChannel

message IMessage

DoSend(IMessageChannel, IMessage, int)

protected void DoSend(IMessageChannel channel, IMessage message, int timeout)

Parameters

channel IMessageChannel

message IMessage

timeout int

DoSendAndReceive(IMessageChannel, IMessage)

protected override IMessage DoSendAndReceive(IMessageChannel destination, IMessage requestMessage)

Parameters

destination IMessageChannel

requestMessage IMessage

Returns

IMessage

DoSendAndReceiveAsync(IMessageChannel, IMessage, CancellationToken)

protected override Task<IMessage> DoSendAndReceiveAsync(IMessageChannel destination, IMessage requestMessage, CancellationToken cancellationToken = default)

Parameters

destination IMessageChannel

requestMessage IMessage

cancellationToken CancellationToken

Returns

Task<IMessage>

DoSendAndReceiveInternalAsync(IMessageChannel, IMessage, CancellationToken)

protected Task<IMessage> DoSendAndReceiveInternalAsync(IMessageChannel channel, IMessage requestMessage, CancellationToken cancellationToken = default)

Parameters

channel IMessageChannel

requestMessage IMessage

cancellationToken CancellationToken

Returns

Task<IMessage>

DoSendAsync(IMessageChannel, IMessage, int, CancellationToken)

protected Task DoSendAsync(IMessageChannel channel, IMessage message, int timeout, CancellationToken cancellationToken = default)

Parameters

channel IMessageChannel

message IMessage

timeout int

cancellationToken CancellationToken

Returns

Task

DoSendAsync(IMessageChannel, IMessage, CancellationToken)

protected override Task DoSendAsync(IMessageChannel destination, IMessage message, CancellationToken cancellationToken)

Parameters

destination IMessageChannel

message IMessage

cancellationToken CancellationToken

Returns

Task

DoSendInternalAsync(IMessageChannel, IMessage, int, CancellationToken)

protected Task DoSendInternalAsync(IMessageChannel channel, IMessage message, int timeout, CancellationToken cancellationToken = default)

Parameters

channel IMessageChannel

message IMessage

timeout int

cancellationToken CancellationToken

Returns

Task

ProcessMessageBeforeSend(IMessage)

protected virtual IMessage ProcessMessageBeforeSend(IMessage message)

Parameters

message IMessage

Returns

IMessage