Class CompositeMessageConverter

Namespace

Steeltoe.Messaging.Converter

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 CompositeMessageConverter : ISmartMessageConverter, IMessageConverter, IServiceNameAware

Inheritance

object

CompositeMessageConverter

Implements

ISmartMessageConverter

IMessageConverter

IServiceNameAware

Derived

ConfigurableCompositeMessageConverter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

CompositeMessageConverter(ICollection<IMessageConverter>)

public CompositeMessageConverter(ICollection<IMessageConverter> converters)

Parameters

converters ICollection<IMessageConverter>

Fields

DEFAULT_SERVICE_NAME

public const string DEFAULT_SERVICE_NAME = "CompositeMessageConverter"

Field Value

string

Properties

Converters

public List<IMessageConverter> Converters { get; }

Property Value

List<IMessageConverter>

ServiceName

public string ServiceName { get; set; }

Property Value

string

Methods

FromMessage(IMessage, Type)

Convert the payload of a message to a typed object.

public object FromMessage(IMessage message, Type targetClass)

Parameters

message IMessage

the input message

targetClass Type

the target type for the conversion

Returns

object

the result of the conversion

FromMessage(IMessage, Type, object)

Convert the payload of a message to a typed object.

public object FromMessage(IMessage message, Type targetClass, object conversionHint)

Parameters

message IMessage

the input message

targetClass Type

the target type of the conversion

conversionHint object

an extra object passed to the converter which may used for handling the conversion

Returns

object

the result of the conversion

FromMessage<T>(IMessage)

Convert the payload of a message to a typed object.

public T FromMessage<T>(IMessage message)

Parameters

message IMessage

the input message

Returns

T

the result of the conversion

Type Parameters

T

the target type for the conversion

FromMessage<T>(IMessage, object)

Convert the payload of a message to a typed object.

public T FromMessage<T>(IMessage message, object conversionHint)

Parameters

message IMessage

the input message

conversionHint object

an extra object passed to the converter which may used for handling the conversion

Returns

T

the result of the conversion

Type Parameters

T

the target type for the conversion

ToMessage(object, IMessageHeaders)

Create a message whose payload is the result of converting the given payload object to serialized form.

public IMessage ToMessage(object payload, IMessageHeaders headers)

Parameters

payload object

the object to convert

headers IMessageHeaders

optional headers for the message

Returns

IMessage

the new messagee or null if converter does not support the payload type

ToMessage(object, IMessageHeaders, object)

Create a message whose payload is the result of converting the given payload object to serialized form.

public IMessage ToMessage(object payload, IMessageHeaders headers, object conversionHint)

Parameters

payload object

the object to convert

headers IMessageHeaders

optional headers for the message

conversionHint object

an extra object passed to the converter which may used for handling the conversion

Returns

IMessage

the new messagee or null if converter does not support the payload type

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.