SimpleAsyncResult

class SimpleAsyncResult(**properties: Any)

Superclasses: Object

Implemented Interfaces: AsyncResult

Constructors:

SimpleAsyncResult(**properties)
new(source_object:GObject.Object=None, callback:Gio.AsyncReadyCallback=None, user_data=None, source_tag=None) -> Gio.SimpleAsyncResult
new_from_error(source_object:GObject.Object=None, callback:Gio.AsyncReadyCallback=None, user_data=None, error:error) -> Gio.SimpleAsyncResult

Constructors

class SimpleAsyncResult

classmethod new(source_object: Object | None, callback: Callable[[...], None] | None, source_tag: None, *user_data: Any) → SimpleAsyncResult

Creates a SimpleAsyncResult.

The common convention is to create the SimpleAsyncResult in the function that starts the asynchronous operation and use that same function as the source_tag.

If your operation supports cancellation with Cancellable (which it probably should) then you should provide the user’s cancellable to set_check_cancellable() immediately after this function returns.

Deprecated since version 2.46: Use new() instead.

Parameters:

source_object – a Object, or None.
callback – a AsyncReadyCallback.
source_tag – the asynchronous function.
user_data – user data passed to callback.

classmethod new_from_error(source_object: Object | None, callback: Callable[[...], None] | None, error: GError, *user_data: Any) → SimpleAsyncResult

Creates a SimpleAsyncResult from an error condition.

Deprecated since version 2.46: Use new() and return_error() instead.

Parameters:

source_object – a Object, or None.
callback – a AsyncReadyCallback.
error – a Error
user_data – user data passed to callback.

Methods

class SimpleAsyncResult

complete() → None

Completes an asynchronous I/O job immediately. Must be called in the thread where the asynchronous result was to be delivered, as it invokes the callback directly. If you are in a different thread use complete_in_idle().

Calling this function takes a reference to simple for as long as is needed to complete the call.

Deprecated since version 2.46: Use Task instead.

complete_in_idle() → None

Completes an asynchronous function in an idle handler in the [thread-default main context][g-main-context-push-thread-default] of the thread that simple was initially created in (and re-pushes that context around the invocation of the callback).

Calling this function takes a reference to simple for as long as is needed to complete the call.

Deprecated since version 2.46: Use Task instead.

get_op_res_gboolean() → bool: Gets the operation result boolean from within the asynchronous result.

Deprecated since version 2.46: Use Task and propagate_boolean() instead.

get_op_res_gssize() → int: Gets a gssize from the asynchronous result.

Deprecated since version 2.46: Use Task and propagate_int() instead.

is_valid(result: AsyncResult, source: Object | None, source_tag: None) → bool

Ensures that the data passed to the _finish function of an async operation is consistent. Three checks are performed.

First, result is checked to ensure that it is really a SimpleAsyncResult. Second, source is checked to ensure that it matches the source object of result. Third, source_tag is checked to ensure that it is equal to the source_tag argument given to new() (which, by convention, is a pointer to the _async function corresponding to the _finish function from which this function is called). (Alternatively, if either source_tag or result’s source tag is None, then the source tag check is skipped.)

Added in version 2.20.

Deprecated since version 2.46: Use Task and is_valid() instead.

Parameters:

result – the AsyncResult passed to the _finish function.
source – the Object passed to the _finish function.
source_tag – the asynchronous function.

propagate_error() → bool

Propagates an error from within the simple asynchronous result to a given destination.

If the Cancellable given to a prior call to set_check_cancellable() is cancelled then this function will return True with dest set appropriately.

Deprecated since version 2.46: Use Task instead.

set_check_cancellable(check_cancellable: Cancellable | None = None) → None

Sets a Cancellable to check before dispatching results.

This function has one very specific purpose: the provided cancellable is checked at the time of propagate_error() If it is cancelled, these functions will return an “Operation was cancelled” error (CANCELLED).

Implementors of cancellable asynchronous functions should use this in order to provide a guarantee to their callers that cancelling an async operation will reliably result in an error being returned for that operation (even if a positive result for the operation has already been sent as an idle to the main context to be dispatched).

The checking described above is done regardless of any call to the unrelated set_handle_cancellation() function.

Added in version 2.32.

Deprecated since version 2.46: Use Task instead.

Parameters:: check_cancellable – a Cancellable to check, or None to unset

set_from_error(error: GError) → None

Sets the result from a Error.

Deprecated since version 2.46: Use Task and return_error() instead.

Parameters:: error – Error.

set_handle_cancellation(handle_cancellation: bool) → None

Sets whether to handle cancellation within the asynchronous operation.

This function has nothing to do with set_check_cancellable(). It only refers to the Cancellable passed to run_in_thread().

Deprecated since version 2.46: Please do not use it in newly written code

Parameters:: handle_cancellation – a gboolean.

set_op_res_gboolean(op_res: bool) → None

Sets the operation result to a boolean within the asynchronous result.

Deprecated since version 2.46: Use Task and return_boolean() instead.

Parameters:: op_res – a gboolean.

set_op_res_gssize(op_res: int) → None

Sets the operation result within the asynchronous result to the given op_res.

Deprecated since version 2.46: Use Task and return_int() instead.

Parameters:: op_res – a gssize.