Show / Hide Table of Contents

    Interface IMessageSerializer

    Serializes and deserializes the messages sent through the broker.

    Namespace: Silverback.Messaging.Serialization
    Assembly: Silverback.Integration.dll
    Syntax
    public interface IMessageSerializer

    Properties

    | Improve this doc View source

    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
    System.Boolean

    Methods

    | Improve this doc View source

    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
    System.IO.Stream messageStream

    The System.IO.Stream containing the message to be deserialized.

    MessageHeaderCollection messageHeaders

    The message headers collection.

    MessageSerializationContext context

    The context information.

    Returns
    Type Description
    System.Threading.Tasks.ValueTask<System.ValueTuple<System.Object, System.Type>>

    A System.Threading.Tasks.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.

    | Improve this doc View source

    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
    System.Object message

    The message object to be serialized.

    MessageHeaderCollection messageHeaders

    The message headers collection.

    MessageSerializationContext context

    The context information.

    Returns
    Type Description
    System.Threading.Tasks.ValueTask<System.IO.Stream>

    A System.Threading.Tasks.Task<TResult> representing the asynchronous operation. The task result contains the System.IO.Stream with the serialized message.

    • Improve this doc
    • View source
    GitHub E-Mail
    ↑ Back to top © 2020 Sergio Aquilini