tur/taskgroup

stdlib/taskgroup.tur
defn

task-group-new

(task-group-new :ptr<void>)

create a new empty TaskGroup.

Since: Phase T22

defn

fiber-cancelled?

(fiber-cancelled? :bool)

check whether the current fiber has been cancelled.

Since: Phase T22

defn

task-group-cancelled?

(task-group-cancelled? [group :ptr<void>] :bool)

check whether a specific task group has been cancelled.

grouptask group handle returned by task-group-new

Since: Phase T22

defn

task-group-should-exit?

(task-group-should-exit? [group :ptr<void>] :bool)

return true if the current task should stop, checking both fiber and group cancellation.

grouptask group handle returned by task-group-new

Since: Phase T22

defn

fiber-should-exit?

(fiber-should-exit? :bool)

check whether the current fiber should exit (without group context).

Since: Phase T22

defn

task-group-done?

(task-group-done? [group :ptr<void>] :bool)

check whether all tasks in the group have completed.

grouptask group handle returned by task-group-new

Since: Phase T22

defn

task-group-task-done

(task-group-task-done [group :ptr<void>] :nil)

signal that the calling task has completed; must be called by each spawned task.

grouptask group handle returned by task-group-new

Since: Phase T22

defn

task-group-wait

(task-group-wait [group :ptr<void>] :nil)

block until all tasks in the group have completed.

grouptask group handle returned by task-group-new

Since: Phase T22

defn

task-group-cancel

(task-group-cancel [group :ptr<void>] :nil)

cooperatively cancel all tasks in the group (reason: manual).

grouptask group handle returned by task-group-new

Since: Phase T22

defn

task-group-cancel-with-reason

(task-group-cancel-with-reason [group :ptr<void> reason :int] :nil)

cancel all tasks in the group with a specific reason code.

grouptask group handle returned by task-group-new
reasoncancel reason: 0=manual, 1=panic, 2=timeout, 3=error

Since: Phase T22

defn

task-group-cancel-panic

(task-group-cancel-panic [group :ptr<void>] :nil)

cancel the group with reason 1 (panic).

grouptask group handle returned by task-group-new

Since: Phase T22

defn

task-group-cancel-timeout

(task-group-cancel-timeout [group :ptr<void>] :nil)

cancel the group with reason 2 (timeout).

grouptask group handle returned by task-group-new

Since: Phase T22

defn

task-group-cancel-error

(task-group-cancel-error [group :ptr<void>] :nil)

cancel the group with reason 3 (error).

grouptask group handle returned by task-group-new

Since: Phase T22

defn

task-group-cancel-reason

(task-group-cancel-reason [group :ptr<void>] :int)

return the reason code why the group was cancelled.

grouptask group handle returned by task-group-new

Since: Phase T22

defn

task-group-spawn

(task-group-spawn [group :ptr<void> f :ptr<void>] :ptr<void>)

spawn a fiber into the task group and return its handle.

grouptask group handle returned by task-group-new
fzero-argument fiber entry-point function pointer

Since: Phase T22

defn

task-group-join

(task-group-join [group :ptr<void> handle :ptr<void>] :nil)

wait for a specific spawned fiber to complete.

grouptask group handle returned by task-group-new
handlefiber handle returned by task-group-spawn

Since: Phase T22

defn

task-handle-done?

(task-handle-done? [handle :ptr<void>] :bool)

non-blocking check whether a specific spawned fiber has completed.

handlefiber handle returned by task-group-spawn

Since: Phase T22

defn

task-group-free

(task-group-free [group :ptr<void>] :nil)

destroy a task group and release its memory.

grouptask group handle returned by task-group-new

Since: Phase T22

defmacro

task-group-with

(task-group-with [group & body])
defmacro

task-group-with-timeout

(task-group-with-timeout [group ms & body])
defn

spawn-timeout-thread

(spawn-timeout-thread [group :ptr<void> ms :int] :ptr<void>)

spawn a background thread that cancels the group after ms milliseconds.

grouptask group handle returned by task-group-new
msdelay in milliseconds before the group is cancelled

Since: Phase T22

defn

join-timeout-thread

(join-timeout-thread [t :ptr<void>] :nil)

free the handle of a detached timeout thread.

tthread handle returned by spawn-timeout-thread

Since: Phase T22

defmacro

task-group-with-cancellation

(task-group-with-cancellation [group & body])
defn

task-group-spawn-async

(task-group-spawn-async [group :ptr<void> f :ptr<void>] :ptr<void>)

spawn an async computation into a task group and return a Future.

grouptask group handle returned by task-group-new
fno-argument function returning int64_t to run as a fiber

Since: Phase T22

defmacro

task-group-async

(task-group-async [group async-thunk])
Internal definitions
__fiber_set_cancelled-- set the current fiber's cancelled flag (internal use only).
__tg-async-entry-- internal fiber entry point for task-group-spawn-async (internal use only).