Package org.jctools.channels.mpsc

Class MpscChannelProducer<E>

java.lang.Object

org.jctools.channels.proxy.ProxyChannelRingBuffer

org.jctools.channels.OffHeapFixedMessageSizeRingBuffer

org.jctools.channels.mpsc.MpscOffHeapFixedSizeRingBuffer

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

Type Parameters:

E - element type.

All Implemented Interfaces:

ChannelProducer<E>

public abstract class MpscChannelProducer<E>
extends MpscOffHeapFixedSizeRingBuffer
implements ChannelProducer<E>

Package Scoped: not part of public API.

Field Summary

Fields

Modifier and Type	Field	Description
protected long	pointer

Fields inherited from class org.jctools.channels.OffHeapFixedMessageSizeRingBuffer

bufferAddress, consumerIndexAddress, HEADER_SIZE, mask, MESSAGE_INDICATOR_SIZE, messageSize, producerIndexAddress, READ_ACQUIRE_INDICATOR, READ_RELEASE_INDICATOR, referenceMessageSize, references, WRITE_ACQUIRE_INDICATOR, WRITE_RELEASE_INDICATOR

Fields inherited from class org.jctools.channels.proxy.ProxyChannelRingBuffer

EOF

Constructor Summary

Constructors

Constructor	Description
MpscChannelProducer(ByteBuffer buffer, int capacity, int messageSize)

Method Summary

Modifier and Type	Method	Description
final boolean	claim()	Attempt to claim the next element in the channel.
final boolean	commit()

Methods inherited from class org.jctools.channels.mpsc.MpscOffHeapFixedSizeRingBuffer

readAcquire, readRelease, writeAcquire, writeRelease, writeRelease

Methods inherited from class org.jctools.channels.OffHeapFixedMessageSizeRingBuffer

arrayIndexForCursor, arrayIndexForCursor, capacity, consumerReferenceArrayIndex, createReferenceArray, getRequiredArraySize, getRequiredBufferSize, isEmpty, isReadReleased, lpConsumerIndex, lpProducerIndex, lvConsumerIndex, lvProducerIndex, offsetForIndex, offsetForIndex, producerReferenceArrayIndex, readAcquireState, readReference, readReleaseState, relativeIndexForOffset, relativeIndexForOffset, size, soConsumerIndex, soProducerIndex, writeAcquireState, writeReference, writeReleaseState

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jctools.channels.ChannelProducer

currentElement

Field Details

pointer

protected long pointer

Constructor Details

MpscChannelProducer

public MpscChannelProducer(ByteBuffer buffer,
 int capacity,
 int messageSize)

Method Details

claim

public final boolean claim()

Description copied from interface: ChannelProducer

Attempt to claim the next element in the channel.

Specified by:

claim in interface ChannelProducer<E>

Returns:

true if claimed, false if there is insufficient space in the channel.

commit

public final boolean commit()

Specified by:

commit in interface ChannelProducer<E>

Returns:

true if