glib/org.gtkkn.bindings.glib/RecMutex

RecMutex

class RecMutex(pointer: <Error class: unknown class><<Error class: unknown class>>) : Record

The GRecMutex struct is an opaque data structure to represent a recursive mutex. It is similar to a #GMutex with the difference that it is possible to lock a GRecMutex multiple times in the same thread without deadlock. When doing so, care has to be taken to unlock the recursive mutex as often as it has been locked.

If a #GRecMutex is allocated in static storage then it can be used without initialisation. Otherwise, you should call g_rec_mutex_init() on it and g_rec_mutex_clear() when done.

A GRecMutex should only be accessed with the g_rec_mutex_ functions.

Skipped during bindings generation

field p: Record field p is private
field i: Record field i is private

Since

2.32

Constructors

RecMutex

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

Types

Companion

object Companion : RecordCompanion<RecMutex, <Error class: unknown class>>

Properties

glibRecMutexPointer

val glibRecMutexPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

clear

fun clear()

Frees the resources allocated to a recursive mutex with g_rec_mutex_init().

init

fun init()

Initializes a #GRecMutex so that it can be used.

lock

fun lock()

Locks @rec_mutex. If @rec_mutex is already locked by another thread, the current thread will block until @rec_mutex is unlocked by the other thread. If @rec_mutex is already locked by the current thread, the 'lock count' of @rec_mutex is increased. The mutex will only become available again when it is unlocked as many times as it has been locked.

trylock

fun trylock(): Boolean

Tries to lock @rec_mutex. If @rec_mutex is already locked by another thread, it immediately returns false. Otherwise it locks @rec_mutex and returns true.

unlock

fun unlock()

Unlocks @rec_mutex. If another thread is blocked in a g_rec_mutex_lock() call for @rec_mutex, it will become unblocked and can lock @rec_mutex itself.