Interface Task.OnTaskThreadFunc

Enclosing class:
Task
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface public static interface Task.OnTaskThreadFunc
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onTaskThreadFunc(CallbackHandler __self, Task task, Pointer source_object, Pointer task_data, Cancellable cancellable)
    The prototype for a task function to be run in a thread via
    g_task_run_in_thread() or g_task_run_in_thread_sync().
  • Method Details

    • onTaskThreadFunc

      void onTaskThreadFunc(CallbackHandler __self, @Nonnull Task task, @Nonnull Pointer source_object, @Nullable Pointer task_data, @Nullable Cancellable cancellable)
      The prototype for a task function to be run in a thread via
      g_task_run_in_thread() or g_task_run_in_thread_sync().

      If the return-on-cancel flag is set on @task, and @cancellable gets
      cancelled, then the #GTask will be completed immediately (as though
      g_task_return_error_if_cancelled() had been called), without
      waiting for the task function to complete. However, the task
      function will continue running in its thread in the background. The
      function therefore needs to be careful about how it uses
      externally-visible state in this case. See
      g_task_set_return_on_cancel() for more details.

      Other than in that case, @task will be completed when the
      #GTaskThreadFunc returns, not when it calls a
      `g_task_return_` function.
      Parameters:
      task - the #GTask
      source_object - @task's source object
      task_data - @task's task data
      cancellable - @task's #GCancellable, or %NULL