Package org.agrona.concurrent.broadcast

Class BroadcastTransmitter

java.lang.Object

org.agrona.concurrent.broadcast.BroadcastTransmitter

public class BroadcastTransmitter
extends Object

Transmit messages via an underlying broadcast buffer to zero or more BroadcastReceivers.

Note: This class is not threadsafe. Only one transmitter is allowed per broadcast buffer.

Constructor Summary

Constructors

Constructor	Description
BroadcastTransmitter(AtomicBuffer buffer)	Construct a new broadcast transmitter based on an underlying AtomicBuffer.

Method Summary

Modifier and Type	Method	Description
int	capacity()	Get the capacity of the underlying broadcast buffer.
int	maxMsgLength()	Get the maximum message length that can be transmitted for a buffer.
void	transmit(int msgTypeId, DirectBuffer srcBuffer, int srcIndex, int length)	Transmit a message to BroadcastReceivers via the broadcast buffer.

Methods inherited from class java.lang.Object

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

Constructor Details

BroadcastTransmitter

public BroadcastTransmitter(AtomicBuffer buffer)

Construct a new broadcast transmitter based on an underlying AtomicBuffer. The underlying buffer must a power of 2 in size plus sufficient space for the BroadcastBufferDescriptor.TRAILER_LENGTH.

Parameters:

buffer - via which messages will be exchanged.

Throws:

IllegalStateException - if the buffer capacity is not a power of 2 plus BroadcastBufferDescriptor.TRAILER_LENGTH in capacity.

Method Details

capacity

public int capacity()

Get the capacity of the underlying broadcast buffer.

Returns:

the capacity of the underlying broadcast buffer.

maxMsgLength

public int maxMsgLength()

Get the maximum message length that can be transmitted for a buffer.

Returns:

the maximum message length that can be transmitted for a buffer.

transmit

public void transmit(int msgTypeId,
 DirectBuffer srcBuffer,
 int srcIndex,
 int length)

Transmit a message to BroadcastReceivers via the broadcast buffer.

Parameters:

msgTypeId - type of the message to be transmitted.

srcBuffer - containing the encoded message to be transmitted.

srcIndex - srcIndex in the source buffer at which the encoded message begins.

length - in bytes of the encoded message.

Throws:

IllegalArgumentException - of the msgTypeId is not valid, or if the message length is greater than maxMsgLength().