Package gc.garcol.libcore

Class OneToManyRingBuffer

java.lang.Object
gc.garcol.libcore.OneToManyRingBuffer
public class OneToManyRingBuffer extends Object
A ring buffer that supports one producer and multiple consumers. Provides methods to write messages to the buffer and read messages from the buffer. Ensures memory visibility guarantees using happen-before relationships.
Since:
2024

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALIGNMENT
    Alignment as a multiple of bytes for each record.
    static final int
    HEADER_LENGTH
    The length of the header in bytes.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OneToManyRingBuffer(int powSize, int consumerSize)
    Constructs a OneToManyRingBuffer with the specified size and number of consumers.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    read(int consumerIndex, MessageHandler handler)
    Reads messages from the ring buffer for the specified consumer.
    int
    read(int consumerIndex, MessageHandler handler, int limit)
    Reads messages from the ring buffer for the specified consumer with a limit.
    boolean
    readOne(int consumerIndex, MessageHandler handler)
    Reads one message from the ring buffer for the specified consumer.
    boolean
    write(int msgTypeId, ByteBuffer message)
    Writes a message to the ring buffer.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • HEADER_LENGTH

      public static final int HEADER_LENGTH
      The length of the header in bytes. The header contains the length and type of the message.
      See Also:

    • ALIGNMENT

      public static final int ALIGNMENT
      Alignment as a multiple of bytes for each record. Padding to align the record in order to prevent false sharing.
      See Also:

  • Constructor Details

    • OneToManyRingBuffer

      public OneToManyRingBuffer(int powSize, int consumerSize)
      Constructs a OneToManyRingBuffer with the specified size and number of consumers.
      Parameters:
      powSize - the power of two size for the ring buffer
      consumerSize - the number of consumers

  • Method Details

    • write

      public boolean write(int msgTypeId, ByteBuffer message)
      Writes a message to the ring buffer.
      Parameters:
      msgTypeId - the type identifier of the message
      message - the message to write, the limit must be equal to the message length
      Returns:
      true if the message was written successfully, false otherwise

    • read

      public int read(int consumerIndex, MessageHandler handler)
      Reads messages from the ring buffer for the specified consumer.
      Parameters:
      consumerIndex - the index of the consumer
      handler - the handler to process the messages
      Returns:
      the number of messages read

    • read

      public int read(int consumerIndex, MessageHandler handler, int limit)
      Reads messages from the ring buffer for the specified consumer with a limit.
      Parameters:
      consumerIndex - the index of the consumer
      handler - the handler to process the messages
      limit - the maximum number of messages to read
      Returns:
      the number of messages read

    • readOne

      public boolean readOne(int consumerIndex, MessageHandler handler)
      Reads one message from the ring buffer for the specified consumer.
      Parameters:
      consumerIndex - the index of the consumer
      handler - the handler to process the message
      Returns:
      true if a message was read, false otherwise