Class SchemaRegistryMessageDeserializer<TMessage>

Namespace

Silverback.Messaging.Serialization

Assembly

Silverback.Integration.Kafka.SchemaRegistry.dll

Connects to the specified schema registry and deserializes the messages.

public abstract class SchemaRegistryMessageDeserializer<TMessage> : IMessageDeserializer where TMessage : class

Type Parameters

TMessage

The type of the messages to be deserialized.

Inheritance

object

SchemaRegistryMessageDeserializer<TMessage>

Implements

IMessageDeserializer

Derived

AvroMessageDeserializer<TMessage>

JsonSchemaRegistryMessageDeserializer<TMessage>

ProtobufMessageDeserializer<TMessage>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SchemaRegistryMessageDeserializer(ISchemaRegistryClient, IAsyncDeserializer<TMessage>)

Initializes a new instance of the SchemaRegistryMessageDeserializer<TMessage> class.

protected SchemaRegistryMessageDeserializer(ISchemaRegistryClient schemaRegistryClient, IAsyncDeserializer<TMessage> confluentDeserializer)

Parameters

schemaRegistryClient ISchemaRegistryClient

The schema registry client.

confluentDeserializer IAsyncDeserializer<TMessage>

The Confluent deserializer to be used to deserialize the message.

Properties

RequireHeaders

Gets a value indicating whether this serializer (with the current configuration) needs the headers support to work properly.

public bool RequireHeaders { get; }

Property Value

bool

SchemaRegistryClient

Gets the schema registry client.

public ISchemaRegistryClient SchemaRegistryClient { get; }

Property Value

ISchemaRegistryClient

Methods

DeserializeAsync(Stream?, MessageHeaderCollection, ConsumerEndpoint)

Deserializes the byte array into a message object.

public ValueTask<DeserializedMessage> DeserializeAsync(Stream? messageStream, MessageHeaderCollection headers, ConsumerEndpoint endpoint)

Parameters

messageStream Stream

The Stream containing the message to be deserialized.

headers MessageHeaderCollection

The message headers collection.

endpoint ConsumerEndpoint

The endpoint.

Returns

ValueTask<DeserializedMessage>

A ValueTask<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.

GetCompatibleSerializer()

Gets a new IMessageSerializer compatible with this deserializer.

public abstract IMessageSerializer GetCompatibleSerializer()

Returns

IMessageSerializer

A new instance of an IMessageSerializer compatible with this deserializer.