org.agrona.concurrent.broadcast

Class BroadcastBufferDescriptor

java.lang.Object

org.agrona.concurrent.broadcast.BroadcastBufferDescriptor

public class BroadcastBufferDescriptor
extends java.lang.Object

Layout of the broadcast buffer. The buffer consists of a ring of messages that is a power of 2 in size. This is followed by a trailer section containing state information about the ring.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LATEST_COUNTER_OFFSET Offset within the trailer for where the latest sequence value is stored.
static int	TAIL_COUNTER_OFFSET Offset within the trailer for where the tail value is stored.
static int	TAIL_INTENT_COUNTER_OFFSET Offset within the trailer for where the tail intended value is stored.
static int	TRAILER_LENGTH Total size of the trailer

Constructor Summary

Constructors

Constructor and Description
BroadcastBufferDescriptor()

Method Summary

Modifier and Type	Method and Description
static void	checkCapacity(int capacity) Check the the buffer capacity is the correct size.

Methods inherited from class java.lang.Object

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

Field Detail

TAIL_INTENT_COUNTER_OFFSET

public static final int TAIL_INTENT_COUNTER_OFFSET

Offset within the trailer for where the tail intended value is stored.

TAIL_COUNTER_OFFSET

public static final int TAIL_COUNTER_OFFSET

Offset within the trailer for where the tail value is stored.

LATEST_COUNTER_OFFSET

public static final int LATEST_COUNTER_OFFSET

Offset within the trailer for where the latest sequence value is stored.

TRAILER_LENGTH

public static final int TRAILER_LENGTH

Total size of the trailer

Constructor Detail

BroadcastBufferDescriptor

public BroadcastBufferDescriptor()

Method Detail

checkCapacity

public static void checkCapacity(int capacity)

Check the the buffer capacity is the correct size.

Parameters:

capacity - to be checked.

Throws:

java.lang.IllegalStateException - if the buffer capacity is not a power of 2.