gAsyncInitableInitAsync: gAsyncInitableInitAsync

Description Usage Arguments Details Author(s)

View source: R/gioFuncs.R

Description

Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements GInitable you can optionally call gInitableInit instead.

Usage

1
2
gAsyncInitableInitAsync(object, io.priority, cancellable = NULL, 
    callback, user.data = NULL)

Arguments

object

a GAsyncInitable.

io.priority

the I/O priority of the operation.

cancellable

optional GCancellable object, NULL to ignore.

callback

a GAsyncReadyCallback to call when the request is satisfied

user.data

the data to pass to callback function

Details

When the initialization is finished, callback will be called. You can then call gAsyncInitableInitFinish to get the result of the initialization.

Implementations may also support cancellation. If cancellable is not NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned. If cancellable is not NULL and the object doesn't support cancellable initialization the error G_IO_ERROR_NOT_SUPPORTED will be returned.

If this function is not called, or returns with an error then all operations on the object should fail, generally returning the error G_IO_ERROR_NOT_INITIALIZED.

Implementations of this method must be idempotent, i.e. multiple calls to this function with the same argument should return the same results. Only the first call initializes the object, further calls return the result of the first call. This is so that its safe to implement the singleton pattern in the GObject constructor function.

For classes that also support the GInitable interface the default implementation of this method will run the gInitableInit function in a thread, so if you want to support asynchronous initialization via threads, just implement the GAsyncInitable interface without overriding any interface methods. Since 2.22

Author(s)

Derived by RGtkGen from GTK+ documentation


RGtk2 documentation built on Oct. 14, 2021, 5:08 p.m.