Class AvroMessageDeserializerBase
The base class for AvroMessageSerializer<TMessage>.
Inherited Members
Namespace: Silverback.Messaging.Serialization
Assembly: Silverback.Integration.Kafka.SchemaRegistry.dll
Syntax
public abstract class AvroMessageDeserializerBase : IKafkaMessageSerializer, IMessageSerializer
Properties
| Improve this doc View sourceAvroDeserializerConfig
Gets or sets the Avro serializer configuration.
Declaration
public AvroDeserializerConfig AvroDeserializerConfig { get; set; }
Property Value
Type | Description |
---|---|
Confluent.SchemaRegistry.Serdes.AvroDeserializerConfig |
RequireHeaders
Gets a value indicating whether headers are mandatory for this serializer implementation or configuration to work properly.
Declaration
public bool RequireHeaders { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
SchemaRegistryConfig
Gets or sets the schema registry configuration.
Declaration
public SchemaRegistryConfig SchemaRegistryConfig { get; set; }
Property Value
Type | Description |
---|---|
Confluent.SchemaRegistry.SchemaRegistryConfig |
Methods
| Improve this doc View sourceDeserializeAsync(Stream, MessageHeaderCollection, MessageSerializationContext)
Deserializes the byte array back into a message object.
Declaration
public abstract 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 |
DeserializeKey(Byte[], IReadOnlyCollection<MessageHeader>, MessageSerializationContext)
Deserializes the byte array back into a key string.
Declaration
public abstract string DeserializeKey(byte[] key, IReadOnlyCollection<MessageHeader> messageHeaders, MessageSerializationContext context)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | key | The byte array to be deserialized. |
System.Collections.Generic.IReadOnlyCollection<MessageHeader> | messageHeaders | The message headers collection. |
MessageSerializationContext | context | The context information. |
Returns
Type | Description |
---|---|
System.String | The deserialized key. |
SerializeAsync(Object, MessageHeaderCollection, MessageSerializationContext)
Serializes the specified message object into a byte array.
Declaration
public abstract 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. |
SerializeKey(String, IReadOnlyCollection<MessageHeader>, MessageSerializationContext)
Serializes the specified key string into a byte array.
Declaration
public abstract byte[] SerializeKey(string key, IReadOnlyCollection<MessageHeader> messageHeaders, MessageSerializationContext context)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The message key to be serialized. |
System.Collections.Generic.IReadOnlyCollection<MessageHeader> | messageHeaders | The message headers collection. |
MessageSerializationContext | context | The context information. |
Returns
Type | Description |
---|---|
System.Byte[] | The serialization result. |