W Wrapl, The Programming Language




Inherits from:

GCancellable is a thread-safe operation cancellation stack used throughout GIO to allow for cancellation of synchronous and asynchronous operations.


Nil : T


GetCurrent() : Gtk.Gio.GCancellable.T

Gets the top cancellable from the stack.

Returns a T from the top of the stack, or NULL if the stack is empty. [transfer none]

GetType() : Gtk.GObject.Type.T

New() : Gtk.Gio.GCancellable.T

Creates a new T object.

Applications that want to start one or more operations that should be cancellable should create a T and pass it to the operations.

One T can be used in multiple consecutive operations or in multiple concurrent operations.

Returns a T.


:Cancel(self @ T) : Std.Object.T

Will set cancellable to cancelled, and will emit the "cancelled" signal. (However, see the warning about race conditions in the documentation for that signal if you are planning to connect to it.)

This function is thread-safe. In other words, you can safely call it from a thread other than the one running the operation that was passed the cancellable.

The convention within gio is that cancelling an asynchronous operation causes it to complete asynchronously. That is, if you cancel the operation from the same thread in which it is running, then the operation's Gtk.Gio.GAsyncReadyCallback will not be invoked until the application returns to the main loop.

cancellable a T object.

:Connect(self @ T, callback @ Std.Object.T, data @ Std.Address.T, data_destroy_func @ Std.Function.T) : Std.Integer.SmallT

Convenience function to connect to the "cancelled" signal. Also handles the race condition that may happen if the cancellable is cancelled right before connecting.

callback is called at most once, either directly at the time of the connect if cancellable is already cancelled, or when cancellable is cancelled in some thread.

data_destroy_func will be called when the handler is disconnected, or immediately if the cancellable is already cancelled.

See "cancelled" for details on how to use this.

cancellable A T.
callback The GCallback to connect.
data Data to pass to callback.
data_destroy_func Free function for data or NULL.
Returns The id of the signal handler or 0 if cancellable has already been cancelled.

:Disconnect(self @ T, handler_id @ Std.Integer.SmallT) : Std.Object.T

Disconnects a handler from a cancellable instance similar to g_signal_handler_disconnect(). Additionally, in the event that a signal handler is currently running, this call will block until the handler has finished. Calling this function from a "cancelled" signal handler will therefore result in a deadlock.

This avoids a race condition where a thread cancels at the same time as the cancellable operation is finished and the signal handler is removed. See "cancelled" for details on how to use this.

If cancellable is NULL or handler_id is 0 this function does nothing.

cancellable A T or NULL.
handler_id Handler id of the handler to be disconnected, or 0.

:GetFd(self @ T) : Std.Integer.SmallT

Gets the file descriptor for a cancellable job. This can be used to implement cancellable operations on Unix systems. The returned fd will turn readable when cancellable is cancelled.

You are not supposed to read from the fd yourself, just check for readable status. Reading to unset the readable status is done with Reset.

After a successful return from this function, you should use ReleaseFd to free up resources allocated for the returned file descriptor.

See also MakePollfd.

cancellable a T.
Returns A valid file descriptor. -1 if the file descriptor is not supported, or on errors.

:IsCancelled(self @ T) : Std.Symbol.T

Checks if a cancellable job has been cancelled.

cancellable a T or NULL. [allow-none]
Returns TRUE if cancellable is cancelled, FALSE if called with NULL or if item is not cancelled.

:MakePollfd(self @ T, pollfd @ Std.Object.T) : Std.Symbol.T

Creates a GPollFD corresponding to cancellable; this can be passed to g_poll() and used to poll for cancellation. This is useful both for unix systems without a native poll and for portability to windows.

When this function returns TRUE, you should use ReleaseFd to free up resources allocated for the pollfd. After a FALSE return, do not call ReleaseFd.

If this function returns FALSE, either no cancellable was given or resource limits prevent this function from allocating the necessary structures for polling. (On Linux, you will likely have reached the maximum number of file descriptors.) The suggested way to handle these cases is to ignore the cancellable.

You are not supposed to read from the fd yourself, just check for readable status. Reading to unset the readable status is done with Reset.

cancellable a T or NULL
pollfd a pointer to a GPollFD
Returns TRUE if pollfd was successfully initialized, FALSE on failure to prepare the cancellable.

:PopCurrent(self @ T) : Std.Object.T

Pops cancellable off the cancellable stack (verifying that cancellable is on the top of the stack).

cancellable a T object

:Priv(self @ T) : Std.Object.T

:PushCurrent(self @ T) : Std.Object.T

Pushes cancellable onto the cancellable stack. The current cancellable can then be received using GetCurrent.

This is useful when implementing cancellable operations in code that does not allow you to pass down the cancellable object.

This is typically called automatically by e.g. Gtk.Gio.GFile.T operations, so you rarely have to call this yourself.

cancellable a T object

:ReleaseFd(self @ T) : Std.Object.T

Releases a resources previously allocated by GetFd or MakePollfd.

For compatibility reasons with older releases, calling this function is not strictly required, the resources will be automatically freed when the cancellable is finalized. However, the cancellable will block scarce file descriptors until it is finalized if this function is not called. This can cause the application to run out of file descriptors when many GCancellables are used at the same time.

cancellable a T

:Reset(self @ T) : Std.Object.T

Resets cancellable to its uncancelled state.

If cancellable is currently in use by any cancellable operation then the behavior of this function is undefined.

cancellable a T object.

:SetErrorIfCancelled(self @ T, error @ Std.Object.T) : Std.Symbol.T

If the cancellable is cancelled, sets the error to notify that the operation was cancelled.

cancellable a T or NULL. [allow-none]
error Gtk.Glib.GError.T to append error state to
Returns TRUE if cancellable was cancelled, FALSE if it was not

:setPriv(self @ T, value @ Std.Object.T) : Std.Object.T