Class MpscChannel<E>

java.lang.Object

org.jctools.channels.mpsc.MpscChannel<E>

All Implemented Interfaces:

Channel<E>

public final class MpscChannel<E>
extends Object
implements Channel<E>

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBuffer	buffer
private static final boolean	debugEnabled
private final int	elementSize
private final Mapper<E>	mapper
private final int	maximumCapacity
private final MpscChannelProducer<E>	producer
private final int	requestedCapacity

Constructor Summary

Constructors

Constructor	Description
MpscChannel(ByteBuffer buffer, int requestedCapacity, Class<E> type)	This is to be used for an IPC queue with the direct buffer used being a memory mapped file.

Method Summary

Modifier and Type	Method	Description
private void	checkByteBuffer()
private void	checkSufficientCapacity()
ChannelConsumer	consumer(ChannelReceiver<E> receiver)
private int	getMaximumCapacity(int requestedCapacity)
boolean	isEmpty()
int	maximumCapacity()
private MpscChannelConsumer<E>	newConsumer(Object... args)
private MpscChannelProducer<E>	newProducer(Class<E> type, Object... args)
ChannelProducer<E>	producer()
int	requestedCapacity()
int	size()	Get the number of elements in the queue.

Methods inherited from class Object

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

Field Details

debugEnabled

private static final boolean debugEnabled

See Also:

• Constant Field Values

elementSize

private final int elementSize

mapper

private final Mapper<E> mapper

buffer

private final ByteBuffer buffer

maximumCapacity

private final int maximumCapacity

requestedCapacity

private final int requestedCapacity

producer

private final MpscChannelProducer<E> producer

Constructor Details

MpscChannel

public MpscChannel(ByteBuffer buffer,
 int requestedCapacity,
 Class<E> type)

This is to be used for an IPC queue with the direct buffer used being a memory mapped file.

Parameters:

buffer -

requestedCapacity -

Method Details

getMaximumCapacity

private int getMaximumCapacity(int requestedCapacity)

checkByteBuffer

private void checkByteBuffer()

checkSufficientCapacity

private void checkSufficientCapacity()

consumer

public ChannelConsumer consumer(ChannelReceiver<E> receiver)

Specified by:

consumer in interface Channel<E>

Parameters:

receiver - the accept function for this consumer

Returns:

a consumer instance to be used for this particular thread.

producer

public ChannelProducer<E> producer()

Specified by:

producer in interface Channel<E>

Returns:

a producer instance to be used for this particular thread.

size

public int size()

Description copied from interface: Channel

Get the number of elements in the queue.

Specified by:

size in interface Channel<E>

Returns:

the number of elements in the queue.

maximumCapacity

public int maximumCapacity()

Specified by:

maximumCapacity in interface Channel<E>

Returns:

the maximum number of elements that can fit in this channel.

requestedCapacity

public int requestedCapacity()

Specified by:

requestedCapacity in interface Channel<E>

Returns:

The requested maximum number of elements that can fit in this channel.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Channel<E>

newProducer

private MpscChannelProducer<E> newProducer(Class<E> type,
 Object... args)

newConsumer

private MpscChannelConsumer<E> newConsumer(Object... args)