io.aeron.logbuffer

Class ExclusiveBufferClaim

java.lang.Object

io.aeron.logbuffer.BufferClaim

io.aeron.logbuffer.ExclusiveBufferClaim

public class ExclusiveBufferClaim
extends BufferClaim

Represents a claimed range in a buffer to be used for recording a message without copy semantics for later commit.

ExclusiveBufferClaims offer additional functionality over standard BufferClaims in that the header can be manipulated for setting flags and type. This allows the user to implement things such as their own fragmentation policy.

The claimed space is in BufferClaim.buffer() between BufferClaim.offset() and BufferClaim.offset() + BufferClaim.length(). When the buffer is filled with message data, use BufferClaim.commit() to make it available to subscribers.

If the claimed space is no longer required it can be aborted by calling BufferClaim.abort().

Data Frame

Field Summary

Fields inherited from class io.aeron.logbuffer.BufferClaim

buffer

Constructor Summary

Constructors

Constructor and Description
ExclusiveBufferClaim()

Method Summary

Modifier and Type	Method and Description
byte	flags() Get the value of the flags field.
ExclusiveBufferClaim	flags(byte flags) Set the value of the header flags field.
int	headerType() Get the value of the header type field.
ExclusiveBufferClaim	headerType(int type) Set the value of the header type field.
ExclusiveBufferClaim	reservedValue(long value) Write the provided value into the reserved space at the end of the data frame header.

Methods inherited from class io.aeron.logbuffer.BufferClaim

abort, buffer, commit, length, offset, reservedValue, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

ExclusiveBufferClaim

public ExclusiveBufferClaim()

Method Detail

reservedValue

public ExclusiveBufferClaim reservedValue(long value)

Write the provided value into the reserved space at the end of the data frame header.

Note: The value will be written in ByteOrder.LITTLE_ENDIAN format.

Overrides:

reservedValue in class BufferClaim

Parameters:

value - to be stored in the reserve space at the end of a data frame header.

Returns:

this for fluent API semantics.

See Also:

DataHeaderFlyweight

flags

public final byte flags()

Get the value of the flags field.

Returns:

the value of the header flags field.

See Also:

DataHeaderFlyweight

flags

public ExclusiveBufferClaim flags(byte flags)

Set the value of the header flags field.

Parameters:

flags - value to be set in the header.

Returns:

this for a fluent API.

See Also:

DataHeaderFlyweight

headerType

public final int headerType()

Get the value of the header type field. The lower 16 bits are valid.

Returns:

the value of the header type field.

See Also:

DataHeaderFlyweight

headerType

public ExclusiveBufferClaim headerType(int type)

Set the value of the header type field. The lower 16 bits are valid.

Parameters:

type - value to be set in the header.

Returns:

this for a fluent API.

See Also:

DataHeaderFlyweight