io.aeron.logbuffer

Class HeaderWriter

java.lang.Object

io.aeron.logbuffer.HeaderWriter

public class HeaderWriter
extends java.lang.Object

Utility for applying a header to a message in a term buffer.

This class is designed to be thread safe to be used across multiple producers and makes the header visible in the correct order for consumers.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	sessionId
protected long	streamId
protected long	versionFlagsType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HeaderWriter(long versionFlagsType, long sessionId, long streamId)

Method Summary

Modifier and Type	Method and Description
static HeaderWriter	newInstance(org.agrona.concurrent.UnsafeBuffer defaultHeader)
void	write(org.agrona.concurrent.UnsafeBuffer termBuffer, int offset, int length, int termId) Write a header to the term buffer in ByteOrder.LITTLE_ENDIAN format using the minimum instructions.

Methods inherited from class java.lang.Object

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

Field Detail

versionFlagsType

protected final long versionFlagsType

sessionId

protected final long sessionId

streamId

protected final long streamId

Constructor Detail

HeaderWriter

protected HeaderWriter(long versionFlagsType,
                       long sessionId,
                       long streamId)

Method Detail

newInstance

public static HeaderWriter newInstance(org.agrona.concurrent.UnsafeBuffer defaultHeader)

write

public void write(org.agrona.concurrent.UnsafeBuffer termBuffer,
                  int offset,
                  int length,
                  int termId)

Write a header to the term buffer in ByteOrder.LITTLE_ENDIAN format using the minimum instructions.

Parameters:

termBuffer - to be written to.

offset - at which the header should be written.

length - of the fragment including the header.

termId - of the current term buffer.