Package org.agrona.concurrent.broadcast

Class CopyBroadcastReceiver

java.lang.Object
org.agrona.concurrent.broadcast.CopyBroadcastReceiver
public class CopyBroadcastReceiver extends Object
Receiver that copies messages which have been broadcast to enable a simpler API for the client.

  • Field Details

    • SCRATCH_BUFFER_LENGTH

      public static final int SCRATCH_BUFFER_LENGTH
      Default length for the scratch buffer for copying messages into.
      See Also:

  • Constructor Details

    • CopyBroadcastReceiver

      public CopyBroadcastReceiver(BroadcastReceiver receiver, MutableDirectBuffer scratchBuffer)
      Wrap a BroadcastReceiver to simplify the API for receiving messages.
      Parameters:
      receiver - to be wrapped.
      scratchBuffer - to be used for copying receive buffers.

    • CopyBroadcastReceiver

      public CopyBroadcastReceiver(BroadcastReceiver receiver, int scratchBufferLength)
      Wrap a BroadcastReceiver to simplify the API for receiving messages.
      Parameters:
      receiver - to be wrapped.
      scratchBufferLength - is the maximum length of a message to be copied when receiving.

    • CopyBroadcastReceiver

      public CopyBroadcastReceiver(BroadcastReceiver receiver)
      Wrap a BroadcastReceiver to simplify the API for receiving messages.
      Parameters:
      receiver - to be wrapped.

  • Method Details

    • broadcastReceiver

      public BroadcastReceiver broadcastReceiver()
      Get the underlying BroadcastReceiver which this is wrapping and copying out of.
      Returns:
      the underlying BroadcastReceiver which this is wrapping and copying out of.

    • receive

      public int receive(MessageHandler handler)
      Receive one message from the broadcast buffer.
      Parameters:
      handler - to be called for each message received.
      Returns:
      the number of messages that have been received.