Package org.freedesktop.gstreamer.base

Class QueueArray

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.freedesktop.gstreamer.base.QueueArray

All Implemented Interfaces:

Proxy

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

GstQueueArray is an object that provides standard queue functionality based on an array instead of linked lists. This reduces the overhead caused by memory management by a large factor.

Constructor Summary

Constructors

Constructor	Description
QueueArray(MemorySegment address)	Create a QueueArray proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears queue this QueueArray and frees all memory associated to it.
MemorySegment	dropElement(int idx)	Drops the queue element at position idx from queue this QueueArray.
boolean	dropStruct(int idx, @Nullable MemorySegment pStruct)	Drops the queue element at position idx from queue this QueueArray and copies the data of the element or structure that was removed into pStruct if pStruct is set (not NULL).
int	find(@Nullable CompareFunc func)	Finds an element in the queue this QueueArray, either by comparing every element with func or by looking up data if no compare function func is provided, and returning the index of the found element.
void	free()	Frees queue this QueueArray and all memory associated to it.
int	getLength()	Returns the length of the queue this QueueArray
boolean	isEmpty()	Checks if the queue this QueueArray is empty.
static QueueArray	new_(int initialSize)	Allocates a new GstQueueArray object with an initial queue size of initialSize.
static QueueArray	newForStruct(long structSize, int initialSize)	Allocates a new GstQueueArray object for elements (e.g.
MemorySegment	peekHead()	Returns the head of the queue this QueueArray and does not remove it from the queue.
MemorySegment	peekHeadStruct()	Returns the head of the queue this QueueArray without removing it from the queue.
MemorySegment	peekNth(int idx)	Returns the item at idx in this QueueArray, but does not remove it from the queue.
MemorySegment	peekNthStruct(int idx)	Returns the item at idx in this QueueArray, but does not remove it from the queue.
MemorySegment	peekTail()	Returns the tail of the queue this QueueArray, but does not remove it from the queue.
MemorySegment	peekTailStruct()	Returns the tail of the queue this QueueArray, but does not remove it from the queue.
MemorySegment	popHead()	Returns and head of the queue this QueueArray and removes it from the queue.
MemorySegment	popHeadStruct()	Returns the head of the queue this QueueArray and removes it from the queue.
MemorySegment	popTail()	Returns the tail of the queue this QueueArray and removes it from the queue.
MemorySegment	popTailStruct()	Returns the tail of the queue this QueueArray and removes it from the queue.
void	pushSorted(@Nullable MemorySegment data, CompareDataFunc func)	Pushes data to the queue this QueueArray, finding the correct position by comparing data with each array element using func.
void	pushSortedStruct(@Nullable MemorySegment pStruct, CompareDataFunc func)	Pushes the element at address pStruct into the queue this QueueArray (copying the contents of a structure of the struct_size specified when creating the queue into the array), finding the correct position by comparing the element at pStruct with each element in the array using func.
void	pushTail(@Nullable MemorySegment data)	Pushes data to the tail of the queue this QueueArray.
void	pushTailStruct(@Nullable MemorySegment pStruct)
void	setClearFunc()	Sets a function to clear an element of this QueueArray.
void	sort(CompareDataFunc compareFunc)	Sorts the queue this QueueArray by comparing elements against each other using the provided compareFunc.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

QueueArray

public QueueArray(MemorySegment address)

Create a QueueArray proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

new_

public static QueueArray new_(int initialSize)

Allocates a new GstQueueArray object with an initial queue size of initialSize.

Parameters:

initialSize - Initial size of the new queue

Returns:

a new GstQueueArray object

newForStruct

public static QueueArray newForStruct(long structSize,
 int initialSize)

Allocates a new GstQueueArray object for elements (e.g. structures) of size structSize, with an initial queue size of initialSize.

Parameters:

structSize - Size of each element (e.g. structure) in the array

initialSize - Initial size of the new queue

Returns:

a new GstQueueArray object

clear

public void clear()

Clears queue this QueueArray and frees all memory associated to it.

dropElement

public MemorySegment dropElement(int idx)

Drops the queue element at position idx from queue this QueueArray.

Parameters:

idx - index to drop

Returns:

the dropped element

dropStruct

public boolean dropStruct(int idx,
 @Nullable
 @Nullable MemorySegment pStruct)

Drops the queue element at position idx from queue this QueueArray and copies the data of the element or structure that was removed into pStruct if pStruct is set (not NULL).

Parameters:

idx - index to drop

pStruct - address into which to store the data of the dropped structure, or NULL

Returns:

TRUE on success, or FALSE on error

find

public int find(@Nullable
 @Nullable CompareFunc func)

Finds an element in the queue this QueueArray, either by comparing every element with func or by looking up data if no compare function func is provided, and returning the index of the found element.

Parameters:

func - comparison function, or null to find data by value

Returns:

Index of the found element or -1 if nothing was found.

free

public void free()

Frees queue this QueueArray and all memory associated to it.

getLength

public int getLength()

Returns the length of the queue this QueueArray

Returns:

the length of the queue this QueueArray.

isEmpty

public boolean isEmpty()

Checks if the queue this QueueArray is empty.

Returns:

true if the queue this QueueArray is empty

peekHead

public MemorySegment peekHead()

Returns the head of the queue this QueueArray and does not remove it from the queue.

Returns:

The head of the queue

peekHeadStruct

public MemorySegment peekHeadStruct()

Returns the head of the queue this QueueArray without removing it from the queue.

Returns:

pointer to element or struct, or NULL if this QueueArray was empty. The data pointed to by the returned pointer stays valid only as long as the queue array is not modified further!

peekNth

public MemorySegment peekNth(int idx)

Returns the item at idx in this QueueArray, but does not remove it from the queue.

Returns:

The item, or null if idx was out of bounds

peekNthStruct

public MemorySegment peekNthStruct(int idx)

Returns the item at idx in this QueueArray, but does not remove it from the queue.

Returns:

The item, or null if idx was out of bounds

peekTail

public MemorySegment peekTail()

Returns the tail of the queue this QueueArray, but does not remove it from the queue.

Returns:

The tail of the queue

peekTailStruct

public MemorySegment peekTailStruct()

Returns the tail of the queue this QueueArray, but does not remove it from the queue.

Returns:

The tail of the queue

popHead

public MemorySegment popHead()

Returns and head of the queue this QueueArray and removes it from the queue.

Returns:

The head of the queue

popHeadStruct

public MemorySegment popHeadStruct()

Returns the head of the queue this QueueArray and removes it from the queue.

Returns:

pointer to element or struct, or NULL if this QueueArray was empty. The data pointed to by the returned pointer stays valid only as long as the queue array is not modified further!

popTail

public MemorySegment popTail()

Returns the tail of the queue this QueueArray and removes it from the queue.

Returns:

The tail of the queue

popTailStruct

public MemorySegment popTailStruct()

Returns the tail of the queue this QueueArray and removes it from the queue.

Returns:

The tail of the queue

pushSorted

public void pushSorted(@Nullable
 @Nullable MemorySegment data,
 CompareDataFunc func)

Pushes data to the queue this QueueArray, finding the correct position by comparing data with each array element using func.

This has a time complexity of O(n), so depending on the size of the queue and expected access patterns, a different data structure might be better.

Assumes that the array is already sorted. If it is not, make sure to call gst_queue_array_sort() first.

Parameters:

data - object to push

func - comparison function

pushSortedStruct

public void pushSortedStruct(@Nullable
 @Nullable MemorySegment pStruct,
 CompareDataFunc func)

Pushes the element at address pStruct into the queue this QueueArray (copying the contents of a structure of the struct_size specified when creating the queue into the array), finding the correct position by comparing the element at pStruct with each element in the array using func.

This has a time complexity of O(n), so depending on the size of the queue and expected access patterns, a different data structure might be better.

Assumes that the array is already sorted. If it is not, make sure to call gst_queue_array_sort() first.

Parameters:

pStruct - address of element or structure to push into the queue

func - comparison function

pushTail

public void pushTail(@Nullable
 @Nullable MemorySegment data)

Pushes data to the tail of the queue this QueueArray.

Parameters:

data - object to push

pushTailStruct

public void pushTailStruct(@Nullable
 @Nullable MemorySegment pStruct)

setClearFunc

public void setClearFunc()

Sets a function to clear an element of this QueueArray.

The clearFunc will be called when an element in the array data segment is removed and when the array is freed and data segment is deallocated as well. clearFunc will be passed a pointer to the element to clear, rather than the element itself.

Note that in contrast with other uses of GDestroyNotify functions, clearFunc is expected to clear the contents of the array element it is given, but not free the element itself.

sort

public void sort(CompareDataFunc compareFunc)

Sorts the queue this QueueArray by comparing elements against each other using the provided compareFunc.

Parameters:

compareFunc - comparison function