org.apache.kafka.server.common.serialization

Interface RecordSerde<T>

All Known Implementing Classes:

AbstractApiMessageSerde

public interface RecordSerde<T>

Serde interface for records written to a metadata log. This class assumes a two-pass serialization, with the first pass used to compute the size of the serialized record, and the second pass to write the object.

Method Summary

Modifier and Type	Method and Description
T	read(org.apache.kafka.common.protocol.Readable input, int size) Read a record from a Readable input.
int	recordSize(T data, org.apache.kafka.common.protocol.ObjectSerializationCache serializationCache) Get the size of a record.
void	write(T data, org.apache.kafka.common.protocol.ObjectSerializationCache serializationCache, org.apache.kafka.common.protocol.Writable out) Write the record to the output stream.

Method Detail

recordSize

int recordSize(T data,
               org.apache.kafka.common.protocol.ObjectSerializationCache serializationCache)

Get the size of a record. This must be called first before writing the data through write(Object, ObjectSerializationCache, Writable).

Parameters:

data - the record that will be serialized

serializationCache - serialization cache

Returns:

the size in bytes of the serialized record

write

void write(T data,
           org.apache.kafka.common.protocol.ObjectSerializationCache serializationCache,
           org.apache.kafka.common.protocol.Writable out)

Write the record to the output stream. This must be called after computing the size with recordSize(Object, ObjectSerializationCache). The same ObjectSerializationCache instance must be used in both calls.

Parameters:

data - the record to serialize and write

serializationCache - serialization cache

out - the output stream to write the record to

read

T read(org.apache.kafka.common.protocol.Readable input,
       int size)

Read a record from a Readable input.

Parameters:

input - the input stream to deserialize

size - the size of the record in bytes

Returns:

the deserialized record