GlueGen v2.6.0-rc-20250712
GlueGen, Native Binding Generator for Java™ (public API).
com.jogamp.common.util.LFRingbuffer< T > Class Template Reference

Simple implementation of Ringbuffer, exposing lock-free get*(..) and put*(..) methods. More...

Inheritance diagram for com.jogamp.common.util.LFRingbuffer< T >:
Collaboration diagram for com.jogamp.common.util.LFRingbuffer< T >:

Public Member Functions

final String toString ()
 Returns a short string representation incl. More...
 
final void dump (final PrintStream stream, final String prefix)
 Debug functionality - Dumps the contents of the internal array. More...
 
 LFRingbuffer (final T[] copyFrom) throws IllegalArgumentException
 Create a full ring buffer instance w/ the given array's net capacity and content. More...
 
 LFRingbuffer (final Class<? extends T[]> arrayType, final int capacity)
 Create an empty ring buffer instance w/ the given net capacity. More...
 
final int capacity ()
 Returns the net capacity of this ring buffer. More...
 
final void clear ()
 Resets the read and write position according to an empty ring buffer and set all ring buffer slots to null. More...
 
final void resetFull (final T[] copyFrom) throws IllegalArgumentException
 Resets the read and write position according to a full ring buffer and fill all slots w/ elements of array copyFrom. More...
 
final int size ()
 Returns the number of elements in this ring buffer. More...
 
final int getFreeSlots ()
 Returns the number of free slots available to put. More...
 
final boolean isEmpty ()
 Returns true if this ring buffer is empty, otherwise false. More...
 
final boolean isFull ()
 Returns true if this ring buffer is full, otherwise false. More...
 
final T get ()
 Dequeues the oldest enqueued element if available, otherwise null.The returned ring buffer slot will be set to null to release the reference and move ownership to the caller. Method is non blocking and returns immediately;.
Returns
the oldest put element if available, otherwise null.
More...
 
final T getBlocking () throws InterruptedException
 Dequeues the oldest enqueued element.The returned ring buffer slot will be set to null to release the reference and move ownership to the caller. Methods blocks until an element becomes available via put.
Returns
the oldest put element
Exceptions
InterruptedException
More...
 
final T peek ()
 Peeks the next element at the read position w/o modifying pointer, nor blocking. More...
 
final T peekBlocking () throws InterruptedException
 Peeks the next element at the read position w/o modifying pointer, but w/ blocking. More...
 
final boolean put (final T e)
 Enqueues the given element.Returns true if successful, otherwise false in case buffer is full. Method is non blocking and returns immediately;. More...
 
final void putBlocking (final T e) throws InterruptedException
 Enqueues the given element.Method blocks until a free slot becomes available via get.
Exceptions
InterruptedException
More...
 
final boolean putSame (final boolean blocking) throws InterruptedException
 Enqueues the same element at it's write position, if not full.Returns true if successful, otherwise false in case buffer is full. If blocking is true, method blocks until a free slot becomes available via get.
Parameters
blockingif true, wait until a free slot becomes available via get.
Exceptions
InterruptedException
More...
 
final void waitForFreeSlots (final int count) throws InterruptedException
 Blocks until at least count free slots become available. More...
 
final void growEmptyBuffer (final T[] newElements) throws IllegalStateException, IllegalArgumentException
 Grows an empty ring buffer, increasing it's capacity about the amount. More...
 
final void growFullBuffer (final int growAmount) throws IllegalStateException, IllegalArgumentException
 Grows a full ring buffer, increasing it's capacity about the amount. More...
 
String toString ()
 Returns a short string representation incl. More...
 
void dump (PrintStream stream, String prefix)
 Debug functionality - Dumps the contents of the internal array. More...
 
int capacity ()
 Returns the net capacity of this ring buffer. More...
 
void clear ()
 Resets the read and write position according to an empty ring buffer and set all ring buffer slots to null. More...
 
void resetFull (T[] copyFrom) throws IllegalArgumentException
 Resets the read and write position according to a full ring buffer and fill all slots w/ elements of array copyFrom. More...
 
int size ()
 Returns the number of elements in this ring buffer. More...
 
int getFreeSlots ()
 Returns the number of free slots available to put. More...
 
boolean isEmpty ()
 Returns true if this ring buffer is empty, otherwise false. More...
 
boolean isFull ()
 Returns true if this ring buffer is full, otherwise false. More...
 
get ()
 Dequeues the oldest enqueued element if available, otherwise null. More...
 
getBlocking () throws InterruptedException
 Dequeues the oldest enqueued element. More...
 
peek ()
 Peeks the next element at the read position w/o modifying pointer, nor blocking. More...
 
peekBlocking () throws InterruptedException
 Peeks the next element at the read position w/o modifying pointer, but w/ blocking. More...
 
boolean put (T e)
 Enqueues the given element. More...
 
void putBlocking (T e) throws InterruptedException
 Enqueues the given element. More...
 
boolean putSame (boolean blocking) throws InterruptedException
 Enqueues the same element at it's write position, if not full. More...
 
void waitForFreeSlots (int count) throws InterruptedException
 Blocks until at least count free slots become available. More...
 
void growEmptyBuffer (T[] newElements) throws IllegalStateException, IllegalArgumentException
 Grows an empty ring buffer, increasing it's capacity about the amount. More...
 
void growFullBuffer (int amount) throws IllegalStateException, IllegalArgumentException
 Grows a full ring buffer, increasing it's capacity about the amount. More...
 

Detailed Description

Simple implementation of Ringbuffer, exposing lock-free get*(..) and put*(..) methods.

Implementation utilizes the Always Keep One Slot Open, hence implementation maintains an internal array of capacity plus one!

Implementation is thread safe if:

Following methods utilize global synchronization:

User needs to synchronize above methods w/ the lock-free w/ get*(..) and put*(..) methods, e.g. by controlling their threads before invoking the above.

Characteristics:

  • Read position points to the last read element.
  • Write position points to the last written element.
EmptywritePos == readPossize == 0
FullwritePos == readPos - 1size == capacity

Definition at line 73 of file LFRingbuffer.java.

Constructor & Destructor Documentation

◆ LFRingbuffer() [1/2]

com.jogamp.common.util.LFRingbuffer< T >.LFRingbuffer ( final T[]  copyFrom) throws IllegalArgumentException

Create a full ring buffer instance w/ the given array's net capacity and content.

Example for a 10 element Integer array:

 Integer[] source = new Integer[10];
 // fill source with content ..
 Ringbuffer<Integer> rb = new LFRingbuffer<Integer>(source);

isFull() returns true on the newly created full ring buffer.

Implementation will allocate an internal array with size of array copyFrom plus one, and copy all elements from array copyFrom into the internal array.

Parameters
copyFrommandatory source array determining ring buffer's net capacity() and initial content.
Exceptions
IllegalArgumentExceptionif copyFrom is null

Definition at line 119 of file LFRingbuffer.java.

◆ LFRingbuffer() [2/2]

com.jogamp.common.util.LFRingbuffer< T >.LFRingbuffer ( final Class<? extends T[]>  arrayType,
final int  capacity 
)

Create an empty ring buffer instance w/ the given net capacity.

Example for a 10 element Integer array:

 Ringbuffer<Integer> rb = new LFRingbuffer<Integer>(10, Integer[].class);

isEmpty() returns true on the newly created empty ring buffer.

Implementation will allocate an internal array of size capacity plus one.

Parameters
arrayTypethe array type of the created empty internal array.
capacitythe initial net capacity of the ring buffer

Definition at line 142 of file LFRingbuffer.java.

Here is the call graph for this function:

Member Function Documentation

◆ capacity()

final int com.jogamp.common.util.LFRingbuffer< T >.capacity ( )

Returns the net capacity of this ring buffer.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 149 of file LFRingbuffer.java.

Here is the caller graph for this function:

◆ clear()

final void com.jogamp.common.util.LFRingbuffer< T >.clear ( )

Resets the read and write position according to an empty ring buffer and set all ring buffer slots to null.

isEmpty() will return true after calling this method.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 152 of file LFRingbuffer.java.

◆ dump()

final void com.jogamp.common.util.LFRingbuffer< T >.dump ( final PrintStream  stream,
final String  prefix 
)

Debug functionality - Dumps the contents of the internal array.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 90 of file LFRingbuffer.java.

Here is the call graph for this function:

◆ get()

Dequeues the oldest enqueued element if available, otherwise null.The returned ring buffer slot will be set to null to release the reference and move ownership to the caller. Method is non blocking and returns immediately;.

Returns
the oldest put element if available, otherwise null.

Implementation advances the read position and returns the element at it, if not empty.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 207 of file LFRingbuffer.java.

◆ getBlocking()

final T com.jogamp.common.util.LFRingbuffer< T >.getBlocking ( ) throws InterruptedException

Dequeues the oldest enqueued element.The returned ring buffer slot will be set to null to release the reference and move ownership to the caller. Methods blocks until an element becomes available via put.

Returns
the oldest put element
Exceptions
InterruptedException

Implementation advances the read position and returns the element at it, if not empty.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 220 of file LFRingbuffer.java.

◆ getFreeSlots()

final int com.jogamp.common.util.LFRingbuffer< T >.getFreeSlots ( )

Returns the number of free slots available to put.


Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 192 of file LFRingbuffer.java.

◆ growEmptyBuffer()

final void com.jogamp.common.util.LFRingbuffer< T >.growEmptyBuffer ( final T[]  newElements) throws IllegalStateException, IllegalArgumentException

Grows an empty ring buffer, increasing it's capacity about the amount.

Growing an empty ring buffer increases it's size about the amount, i.e. renders it not empty. The new elements are inserted at the read position, able to be read out via get() etc.

Parameters
newElementsarray of new full elements the empty buffer shall grow about.
Exceptions
IllegalStateExceptionif buffer is not empty
IllegalArgumentExceptionif newElements is null

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 336 of file LFRingbuffer.java.

◆ growFullBuffer()

final void com.jogamp.common.util.LFRingbuffer< T >.growFullBuffer ( final int  amount) throws IllegalStateException, IllegalArgumentException

Grows a full ring buffer, increasing it's capacity about the amount.

Growing a full ring buffer leaves the size intact, i.e. renders it not full. New null elements are inserted at the write position, able to be written to via put(Object) etc.

Parameters
amountthe amount of elements the buffer shall grow about
Exceptions
IllegalStateExceptionif buffer is not full
IllegalArgumentExceptionif amount is < 0

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 384 of file LFRingbuffer.java.

◆ isEmpty()

final boolean com.jogamp.common.util.LFRingbuffer< T >.isEmpty ( )

Returns true if this ring buffer is empty, otherwise false.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 195 of file LFRingbuffer.java.

◆ isFull()

final boolean com.jogamp.common.util.LFRingbuffer< T >.isFull ( )

Returns true if this ring buffer is full, otherwise false.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 198 of file LFRingbuffer.java.

◆ peek()

final T com.jogamp.common.util.LFRingbuffer< T >.peek ( )

Peeks the next element at the read position w/o modifying pointer, nor blocking.

Returns
null if empty, otherwise the element which would be read next.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 225 of file LFRingbuffer.java.

◆ peekBlocking()

final T com.jogamp.common.util.LFRingbuffer< T >.peekBlocking ( ) throws InterruptedException

Peeks the next element at the read position w/o modifying pointer, but w/ blocking.

Returns
null if empty, otherwise the element which would be read next.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 231 of file LFRingbuffer.java.

◆ put()

final boolean com.jogamp.common.util.LFRingbuffer< T >.put ( final T  e)

Enqueues the given element.Returns true if successful, otherwise false in case buffer is full. Method is non blocking and returns immediately;.

Implementation advances the write position and stores the given element at it, if not full.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 268 of file LFRingbuffer.java.

◆ putBlocking()

final void com.jogamp.common.util.LFRingbuffer< T >.putBlocking ( final T  e) throws InterruptedException

Enqueues the given element.Method blocks until a free slot becomes available via get.

Exceptions
InterruptedException

Implementation advances the write position and stores the given element at it, if not full.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 281 of file LFRingbuffer.java.

◆ putSame()

final boolean com.jogamp.common.util.LFRingbuffer< T >.putSame ( final boolean  blocking) throws InterruptedException

Enqueues the same element at it's write position, if not full.Returns true if successful, otherwise false in case buffer is full. If blocking is true, method blocks until a free slot becomes available via get.

Parameters
blockingif true, wait until a free slot becomes available via get.
Exceptions
InterruptedException

Implementation advances the write position and keeps the element at it, if not full.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 294 of file LFRingbuffer.java.

◆ resetFull()

final void com.jogamp.common.util.LFRingbuffer< T >.resetFull ( final T[]  copyFrom) throws IllegalArgumentException

Resets the read and write position according to a full ring buffer and fill all slots w/ elements of array copyFrom.

Array's copyFrom elements will be copied into the internal array, hence it's length must be equal to capacity().

Parameters
copyFromMandatory array w/ length capacity() to be copied into the internal array.
Exceptions
IllegalArgumentExceptionif copyFrom is null.
IllegalArgumentExceptionif copyFrom's length is different from capacity().

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 162 of file LFRingbuffer.java.

◆ size()

final int com.jogamp.common.util.LFRingbuffer< T >.size ( )

Returns the number of elements in this ring buffer.

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 189 of file LFRingbuffer.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toString()

final String com.jogamp.common.util.LFRingbuffer< T >.toString ( )

Returns a short string representation incl.

size/capacity and internal r/w index (impl. dependent).

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 85 of file LFRingbuffer.java.

Here is the caller graph for this function:

◆ waitForFreeSlots()

final void com.jogamp.common.util.LFRingbuffer< T >.waitForFreeSlots ( final int  count) throws InterruptedException

Blocks until at least count free slots become available.

Exceptions
InterruptedException

Implements com.jogamp.common.util.Ringbuffer< T >.

Definition at line 325 of file LFRingbuffer.java.


The documentation for this class was generated from the following file: