glib/org.gtkkn.bindings.glib/AsyncQueue

AsyncQueue

class AsyncQueue(pointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance

An opaque data structure which represents an asynchronous queue.

It should only be accessed through the g_async_queue_* functions.

Skipped during bindings generation

method ref: Return type AsyncQueue is unsupported
function new: Return type AsyncQueue is unsupported
parameter item_free_func: DestroyNotify

Constructors

AsyncQueue

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Properties

glibAsyncQueuePointer

val glibAsyncQueuePointer: <Error class: unknown class><<Error class: unknown class>>

handle

open override val handle: <Error class: unknown class>?

Functions

equals

open operator override fun equals(other: Any?): Boolean

Compare two proxy instances for equality. This will compare both the type of the instances, and their memory addresses.

hashCode

open override fun hashCode(): Int

length

fun length(): <Error class: unknown class>

Returns the length of the queue.

lengthUnlocked

fun lengthUnlocked(): <Error class: unknown class>

Returns the length of the queue.

lock

fun lock()

Acquires the @queue's lock. If another thread is already holding the lock, this call will block until the lock becomes available.

pop

fun pop(): <Error class: unknown class>?

Pops data from the @queue. If @queue is empty, this function blocks until data becomes available.

popUnlocked

fun popUnlocked(): <Error class: unknown class>?

Pops data from the @queue. If @queue is empty, this function blocks until data becomes available.

push

fun push(data: <Error class: unknown class>)

Pushes the @data into the @queue.

pushFront

fun pushFront(item: <Error class: unknown class>)

Pushes the @item into the @queue. @item must not be null. In contrast to g_async_queue_push(), this function pushes the new item ahead of the items already in the queue, so that it will be the next one to be popped off the queue.

pushFrontUnlocked

fun pushFrontUnlocked(item: <Error class: unknown class>)

Pushes the @item into the @queue. @item must not be null. In contrast to g_async_queue_push_unlocked(), this function pushes the new item ahead of the items already in the queue, so that it will be the next one to be popped off the queue.

pushSorted

fun pushSorted(data: <Error class: unknown class>, func: CompareDataFunc)

Inserts @data into @queue using @func to determine the new position.

pushSortedUnlocked

fun pushSortedUnlocked(data: <Error class: unknown class>? = null, func: CompareDataFunc)

Inserts @data into @queue using @func to determine the new position.

pushUnlocked

fun pushUnlocked(data: <Error class: unknown class>)

Pushes the @data into the @queue.

refUnlocked

fun refUnlocked()

Increases the reference count of the asynchronous @queue by 1.

remove

fun remove(item: <Error class: unknown class>): Boolean

Remove an item from the queue.

removeUnlocked

fun removeUnlocked(item: <Error class: unknown class>? = null): Boolean

Remove an item from the queue.

sort

fun sort(func: CompareDataFunc)

Sorts @queue using @func.

sortUnlocked

fun sortUnlocked(func: CompareDataFunc)

Sorts @queue using @func.

timedPop

fun timedPop(endTime: TimeVal): <Error class: unknown class>?

Pops data from the @queue. If the queue is empty, blocks until

timedPopUnlocked

fun timedPopUnlocked(endTime: TimeVal): <Error class: unknown class>?

Pops data from the @queue. If the queue is empty, blocks until

timeoutPop

fun timeoutPop(timeout: <Error class: unknown class>): <Error class: unknown class>?

Pops data from the @queue. If the queue is empty, blocks for

timeoutPopUnlocked

fun timeoutPopUnlocked(timeout: <Error class: unknown class>): <Error class: unknown class>?

Pops data from the @queue. If the queue is empty, blocks for

tryPop

fun tryPop(): <Error class: unknown class>?

Tries to pop data from the @queue. If no data is available, null is returned.

tryPopUnlocked

fun tryPopUnlocked(): <Error class: unknown class>?

Tries to pop data from the @queue. If no data is available, null is returned.

unlock

fun unlock()

Releases the queue's lock.

unref

fun unref()

Decreases the reference count of the asynchronous @queue by 1.

unrefAndUnlock

fun unrefAndUnlock()

Decreases the reference count of the asynchronous @queue by 1 and releases the lock. This function must be called while holding the @queue's lock. If the reference count went to 0, the @queue will be destroyed and the memory allocated will be freed.