glib/org.gtkkn.bindings.glib/AsyncQueue

AsyncQueue

class AsyncQueue(val glibAsyncQueuePointer: <Error class: unknown class><<Error class: unknown class>>) : ProxyInstance(source)

An opaque data structure which represents an asynchronous queue.

It should only be accessed through the g_async_queue_* functions.

Skipped during bindings generation

parameter item_free_func: DestroyNotify

Constructors

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

Types

object Companion

Properties

glibAsyncQueuePointer

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

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

Functions

open override fun addCleaner(cleaner: <Error class: unknown class>): Boolean

Registers a cleaner to be executed when this proxy object is garbage collected.

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.

getSimpleNameWithHandle

open fun getSimpleNameWithHandle(): String

open override fun hashCode(): Int

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

Returns the length of the queue.

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

Returns the length of the queue.

fun lock()

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

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

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

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

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

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

Pushes the @data into the @queue.

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.

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.

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

Pushes the @data into the @queue.

fun ref(): AsyncQueue

Increases the reference count of the asynchronous @queue by 1. You do not need to hold the lock to call this function.

fun refUnlocked()

This is deprecated since version 2.8.

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

Remove an item from the queue.

open override fun removeCleaner(cleaner: <Error class: unknown class>): Boolean

Removes a previously registered cleaner from this proxy object.

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

Remove an item from the queue.

fun sort(func: CompareDataFunc)

Sorts @queue using @func.

fun sortUnlocked(func: CompareDataFunc)

Sorts @queue using @func.

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

This is deprecated.

timedPopUnlocked

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

This is deprecated.

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

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

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

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

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

fun unlock()

Releases the queue's lock.

fun unref()

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

fun unrefAndUnlock()

This is deprecated since version 2.8.