Package org.freedesktop.gstreamer.gst

Class AtomicQueue

java.lang.Object

org.javagi.base.ProxyInstance

org.freedesktop.gstreamer.gst.AtomicQueue

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class AtomicQueue
extends ProxyInstance

The GstAtomicQueue object implements a queue that can be used from multiple threads without performing any blocking operations.

Constructor Summary

Constructors

Constructor	Description
AtomicQueue(int initialSize)	Create a new atomic queue instance.
AtomicQueue(MemorySegment address)	Create a AtomicQueue proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static @Nullable Type	getType()	Get the GType of the AtomicQueue class
int	length()	Get the amount of items in the queue.
@Nullable MemorySegment	peek()	Peek the head element of the queue without removing it from the queue.
@Nullable MemorySegment	pop()	Get the head element of the queue.
void	push(@Nullable MemorySegment data)	Append data to the tail of the queue.
void	ref()	Increase the refcount of queue.
void	unref()	Unref this AtomicQueue and free the memory when the refcount reaches 0.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

AtomicQueue

public AtomicQueue(MemorySegment address)

Create a AtomicQueue proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

AtomicQueue

public AtomicQueue(int initialSize)

Create a new atomic queue instance. initialSize will be rounded up to the nearest power of 2 and used as the initial size of the queue.

Parameters:

initialSize - initial queue size

Method Details

getType

public static @Nullable Type getType()

Get the GType of the AtomicQueue class

Returns:

the GType

length

public int length()

Get the amount of items in the queue.

Returns:

the number of elements in the queue.

peek

public @Nullable MemorySegment peek()

Peek the head element of the queue without removing it from the queue.

Returns:

the head element of this AtomicQueue or null when the queue is empty.

pop

public @Nullable MemorySegment pop()

Get the head element of the queue.

Returns:

the head element of this AtomicQueue or null when the queue is empty.

push

public void push(@Nullable MemorySegment data)

Append data to the tail of the queue.

Parameters:

data - the data

ref

public void ref()

Increase the refcount of queue.

unref

public void unref()

Unref this AtomicQueue and free the memory when the refcount reaches 0.