aboutsummaryrefslogtreecommitdiff
path: root/share/man/man9
diff options
context:
space:
mode:
authorMatthew D Fleming <mdf@FreeBSD.org>2010-10-12 18:36:03 +0000
committerMatthew D Fleming <mdf@FreeBSD.org>2010-10-12 18:36:03 +0000
commita92f0ee8664a4f5f6e6cdc5a20f7e97c808de05a (patch)
tree876724459ab9be381dd89acdb1b5e8dfdabdc332 /share/man/man9
parentf3bf9b7a16d86de525a07b095a28ba1068cadf6f (diff)
downloadsrc-a92f0ee8664a4f5f6e6cdc5a20f7e97c808de05a.tar.gz
src-a92f0ee8664a4f5f6e6cdc5a20f7e97c808de05a.zip
Re-expose and briefly document taskqueue_run(9). The function is used
in at least one 3rd party driver. Requested by: jhb
Notes
Notes: svn path=/head/; revision=213739
Diffstat (limited to 'share/man/man9')
-rw-r--r--share/man/man9/taskqueue.915
1 files changed, 15 insertions, 0 deletions
diff --git a/share/man/man9/taskqueue.9 b/share/man/man9/taskqueue.9
index d2451a48774d..83fb051d6935 100644
--- a/share/man/man9/taskqueue.9
+++ b/share/man/man9/taskqueue.9
@@ -67,6 +67,8 @@ struct task {
.Fn taskqueue_drain "struct taskqueue *queue" "struct task *task"
.Ft int
.Fn taskqueue_member "struct taskqueue *queue" "struct thread *td"
+.Ft void
+.Fn taskqueue_run "struct taskqueue *queue" "struct task **tpp"
.Fn TASK_INIT "struct task *task" "int priority" "task_fn_t *func" "void *context"
.Fn TASKQUEUE_DECLARE "name"
.Fn TASKQUEUE_DEFINE "name" "taskqueue_enqueue_fn enqueue" "void *context" "init"
@@ -178,6 +180,19 @@ and
.No 0
otherwise.
.Pp
+The
+.Fn taskqueue_run
+function will run all pending tasks in the specified
+.Fa queue .
+Normally this function is only used internally.
+The
+.Fa tpp
+argument is a pointer to a
+.Vt struct task *
+that is used to record the currently running task.
+The lifetime of this pointer must match that of the
+.Fa queue .
+.Pp
A convenience macro,
.Fn TASK_INIT "task" "priority" "func" "context"
is provided to initialise a