gobject/org.gtkkn.bindings.gobject/WeakRef

WeakRef

class WeakRef(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null)

A structure containing a weak reference to a #GObject.

A GWeakRef can either be empty (i.e. point to null), or point to an object for as long as at least one "strong" reference to that object exists. Before the object's #GObjectClass.dispose method is called, every #GWeakRef associated with becomes empty (i.e. points to null).

Like #GValue, #GWeakRef can be statically allocated, stack- or heap-allocated, or embedded in larger structures.

Unlike g_object_weak_ref() and g_object_add_weak_pointer(), this weak reference is thread-safe: converting a weak pointer to a reference is atomic with respect to invalidation of weak pointers to destroyed objects.

If the object's #GObjectClass.dispose method results in additional references to the object being held (‘re-referencing’), any #GWeakRefs taken before it was disposed will continue to point to null. Any #GWeakRefs taken during disposal and after re-referencing, or after disposal has returned due to the re-referencing, will continue to point to the object until its refcount goes back to zero, at which point they too will be invalidated.

It is invalid to take a #GWeakRef on an object during #GObjectClass.dispose without first having or creating a strong reference to the object.

Constructors

WeakRef

constructor()

Allocate a new WeakRef.

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

Allocate a new WeakRef using the provided AutofreeScope.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>, cleaner: <Error class: unknown class>? = null)

Properties

gobjectWeakRefPointer

val gobjectWeakRefPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

clear

fun clear()

Frees resources associated with a non-statically-allocated #GWeakRef. After this call, the #GWeakRef is left in an undefined state.

get

fun get(): Object

If @weak_ref is not empty, atomically acquire a strong reference to the object it points to, and return that reference.

init

fun init(object: Object? = null)

Initialise a non-statically-allocated #GWeakRef.

set

fun set(object: Object? = null)

Change the object to which @weak_ref points, or set it to null.