Interface IMessageSerializer

Serializes and deserializes the messages sent through the broker.

Namespace: Silverback.Messaging.Serialization

Assembly: Silverback.Integration.dll

Syntax

public interface IMessageSerializer

Properties

RequireHeaders

Gets a value indicating whether headers are mandatory for this serializer implementation or configuration to work properly.

Declaration

bool RequireHeaders { get; }

Property Value

Type	Description
bool

Methods

DeserializeAsync(Stream?, MessageHeaderCollection, MessageSerializationContext)

Deserializes the byte array back into a message object.

Declaration

ValueTask<(object? Message, Type MessageType)> DeserializeAsync(Stream? messageStream, MessageHeaderCollection messageHeaders, MessageSerializationContext context)

Parameters

Type	Name	Description
Stream	messageStream	The Stream containing the message to be deserialized.
MessageHeaderCollection	messageHeaders	The message headers collection.
MessageSerializationContext	context	The context information.

Returns

Type	Description
ValueTask<(object Message, Type MessageType)>	A Task<TResult> representing the asynchronous operation. The task result contains the deserialized message (or null when the input is null or empty) and the type of the message.

SerializeAsync(object?, MessageHeaderCollection, MessageSerializationContext)

Serializes the specified message object into a byte array.

Declaration

ValueTask<Stream?> SerializeAsync(object? message, MessageHeaderCollection messageHeaders, MessageSerializationContext context)

Parameters

Type	Name	Description
object	message	The message object to be serialized.
MessageHeaderCollection	messageHeaders	The message headers collection.
MessageSerializationContext	context	The context information.

Returns

Type	Description
ValueTask<Stream>	A Task<TResult> representing the asynchronous operation. The task result contains the Stream with the serialized message.