Interface TaskThreadFunc

All Superinterfaces:

FunctionPointer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@Generated("org.javagi.JavaGI")
public interface TaskThreadFunc
extends FunctionPointer

Functional interface declaration of the TaskThreadFunc callback.

See Also:

• run(Task, GObject, MemorySegment, Cancellable)

Method Summary

Modifier and Type	Method	Description
void	run(Task task, GObject sourceObject, @Nullable MemorySegment taskData, @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().
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(MemorySegment, MemorySegment, MemorySegment, MemorySegment) method.
default void	upcall(MemorySegment task, MemorySegment sourceObject, MemorySegment taskData, MemorySegment cancellable)	The upcall method is called from native code.

Method Details

run

void run(Task task,
 GObject sourceObject,
 @Nullable MemorySegment taskData,
 @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

sourceObject - task's source object

taskData - task's task data

cancellable - task's GCancellable, or null

Since:

2.36

upcall

default void upcall(MemorySegment task,
 MemorySegment sourceObject,
 MemorySegment taskData,
 MemorySegment cancellable)

The upcall method is called from native code. The parameters are marshaled and run(Task, GObject, MemorySegment, Cancellable) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(MemorySegment, MemorySegment, MemorySegment, MemorySegment) method.

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer