Package io.camunda.zeebe.journal.record

Class SBESerializer

java.lang.Object

io.camunda.zeebe.journal.record.SBESerializer

All Implemented Interfaces:

JournalRecordSerializer

public final class SBESerializer
extends Object
implements JournalRecordSerializer

The serializer that writes and reads a journal record according to the SBE schema defined.

Constructor Summary

Constructors

Constructor	Description
SBESerializer()

Method Summary

Modifier and Type	Method	Description
int	getMetadataLength()	Returns the number of bytes required to write a RecordMetadata to a buffer.
int	getMetadataLength(org.agrona.DirectBuffer buffer, int offset)	Returns the length of the serialized RecordMetadata in the buffer.
RecordData	readData(org.agrona.DirectBuffer buffer, int offset)	Reads the RecordData from the buffer at offset 0.
RecordMetadata	readMetadata(org.agrona.DirectBuffer buffer, int offset)	Reads the RecordMetadata from the buffer at offset 0.
Either<BufferOverflowException,Integer>	writeData(long index, long asqn, BufferWriter recordDataWriter, org.agrona.MutableDirectBuffer writeBuffer, int offset)
int	writeMetadata(RecordMetadata metadata, org.agrona.MutableDirectBuffer buffer, int offset)	Writes a RecordMetadata to the buffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.camunda.zeebe.journal.record.JournalRecordSerializer

writeData

Constructor Details

SBESerializer

public SBESerializer()

Method Details

writeData

public Either<BufferOverflowException,Integer> writeData(long index,
 long asqn,
 BufferWriter recordDataWriter,
 org.agrona.MutableDirectBuffer writeBuffer,
 int offset)

Specified by:

writeData in interface JournalRecordSerializer

writeMetadata

public int writeMetadata(RecordMetadata metadata,
 org.agrona.MutableDirectBuffer buffer,
 int offset)

Description copied from interface: JournalRecordSerializer

Writes a RecordMetadata to the buffer.

Specified by:

writeMetadata in interface JournalRecordSerializer

Parameters:

metadata - to write

buffer - to which the metadata will be written

offset - the offset in the buffer at which the metadata will be written

Returns:

the number of bytes that were written to the buffer

getMetadataLength

public int getMetadataLength()

Description copied from interface: JournalRecordSerializer

Returns the number of bytes required to write a RecordMetadata to a buffer. The length returned by this method must be equal to the length returned by JournalRecordSerializer.writeMetadata(RecordMetadata, MutableDirectBuffer, int)

Specified by:

getMetadataLength in interface JournalRecordSerializer

Returns:

the expected length of a serialized metadata

readMetadata

public RecordMetadata readMetadata(org.agrona.DirectBuffer buffer,
 int offset)

Description copied from interface: JournalRecordSerializer

Reads the RecordMetadata from the buffer at offset 0. A valid record must exist in the buffer at this position.

Specified by:

readMetadata in interface JournalRecordSerializer

Parameters:

buffer - to read

offset - the offset in the buffer at which the metadata will be read from

Returns:

a journal record metadata that is read.

readData

public RecordData readData(org.agrona.DirectBuffer buffer,
 int offset)

Description copied from interface: JournalRecordSerializer

Reads the RecordData from the buffer at offset 0. A valid record must exist in the buffer at this position.

Specified by:

readData in interface JournalRecordSerializer

Parameters:

buffer - to read

offset - the offset in the buffer at which the data will be read from

Returns:

a journal indexed record that is read.

getMetadataLength

public int getMetadataLength(org.agrona.DirectBuffer buffer,
 int offset)

Description copied from interface: JournalRecordSerializer

Returns the length of the serialized RecordMetadata in the buffer.

Specified by:

getMetadataLength in interface JournalRecordSerializer

Parameters:

buffer - to read

offset - the offset in the buffer at which the metadata will be read from

Returns:

the length of the metadata