net.openhft.chronicle.queue.impl.ringbuffer

Class BytesRingBuffer

java.lang.Object

net.openhft.chronicle.queue.impl.ringbuffer.BytesRingBuffer

public class BytesRingBuffer
extends Object

Multi writer single Reader, zero GC, ring buffer, which takes bytes

Author:

Rob Austin.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BytesRingBuffer.BytesProvider

Constructor Summary

Constructors

Constructor and Description
BytesRingBuffer(net.openhft.chronicle.bytes.Bytes buffer)

Method Summary

Modifier and Type	Method and Description
boolean	offer(net.openhft.chronicle.bytes.Bytes bytes0) Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity,
net.openhft.chronicle.bytes.Bytes	poll(BytesRingBuffer.BytesProvider bytesProvider) Retrieves and removes the head of this queue, or returns null if this queue is empty.
net.openhft.chronicle.bytes.Bytes	take(BytesRingBuffer.BytesProvider bytesProvider)

Methods inherited from class java.lang.Object

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

Constructor Detail

BytesRingBuffer

public BytesRingBuffer(@NotNull
                       net.openhft.chronicle.bytes.Bytes buffer)

Parameters:

buffer - the bytes that you wish to use for the ring buffer

Method Detail

offer

public boolean offer(@NotNull
                     net.openhft.chronicle.bytes.Bytes bytes0)
              throws InterruptedException

Inserts the specified element at the tail of this queue if it is possible to do so immediately without exceeding the queue's capacity,

Parameters:

bytes0 - the bytes0 that you wish to add to the ring buffer

Returns:

returning true upon success and false if this queue is full.

Throws:

InterruptedException

take

@NotNull
public net.openhft.chronicle.bytes.Bytes take(@NotNull
                                                       BytesRingBuffer.BytesProvider bytesProvider)
                                                throws InterruptedException,
                                                       IllegalStateException

Throws:

InterruptedException

IllegalStateException

poll

@Nullable
public net.openhft.chronicle.bytes.Bytes poll(@NotNull
                                                        BytesRingBuffer.BytesProvider bytesProvider)
                                                 throws InterruptedException,
                                                        IllegalStateException

Retrieves and removes the head of this queue, or returns null if this queue is empty.

Returns:

null if this queue is empty, or a populated buffer if the element was retried

Throws:

IllegalStateException - is the using buffer is not large enough

InterruptedException