Table of Contents

Class AvroRegistryFraming

Namespace
AvroSharp.Messages
Assembly
AvroSharp.dll

How a schema registry frames a message: the bytes in front of the Avro binary data that identify its schema. Each registry's layout is a fixed instance; see AvroRegistryMessage and AvroRegistryMessageReader<T>.

public sealed class AvroRegistryFraming
Inheritance
AvroRegistryFraming
Inherited Members

Properties

Apicurio

Gets Apicurio Registry 3's default framing (Default4ByteIdHandler): the byte 0x00, then the ID (the content ID by default) as a 4-byte big-endian integer. It is the same layout as Confluent.

Apicurio8Byte

Gets Apicurio's 8-byte framing (Apicurio Registry 2's default, Legacy8ByteIdHandler in 3): the byte 0x00, then the ID (the global ID by default in 2) as an 8-byte big-endian integer.

AwsGlue

Gets AWS Glue Schema Registry's framing, uncompressed: the header version byte 0x03, the compression byte 0x00, then the schema version ID as a 16-byte big-endian UUID. Reading also accepts zlib-compressed data (compression byte 0x05).

AwsGlueCompressed

Gets AWS Glue Schema Registry's framing with zlib compression (compression byte 0x05): the Avro data after the header is compressed, as the Glue serializer does when compression is enabled.

Compresses

Gets whether writing compresses the Avro data (AWS Glue with zlib).

Confluent

Gets Confluent's framing: the byte 0x00, then the schema ID as a 4-byte big-endian integer.

ConfluentGuid

Gets Confluent's version 1 framing (Confluent Platform 8): the byte 0x01, then the schema GUID as 16 big-endian bytes (the 8-4-4-4-12 text form, in order).

HeaderLength

Gets the number of bytes in front of the Avro data.

Name

Gets the framing's name.

Methods

ToString()

Returns a string that represents the current object.

TryReadHeader(ReadOnlySpan<byte>, out AvroSchemaId)

Reads the header of a message in this framing.

WriteHeader(Span<byte>, AvroSchemaId)

Writes the header for id.

See Also