summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorglebius <glebius@FreeBSD.org>2005-05-19 18:31:42 +0000
committerglebius <glebius@FreeBSD.org>2005-05-19 18:31:42 +0000
commit4ae1073a42ebb55570a6540fb69368248c904672 (patch)
tree3e28c82624d8320bd7932c033f4b6613e509f1f9
parentb007f0a4884659fea43f858bf560fa46257ff515 (diff)
downloadFreeBSD-src-4ae1073a42ebb55570a6540fb69368248c904672.zip
FreeBSD-src-4ae1073a42ebb55570a6540fb69368248c904672.tar.gz
Document taskqueue_drain().
-rw-r--r--share/man/man9/taskqueue.911
1 files changed, 10 insertions, 1 deletions
diff --git a/share/man/man9/taskqueue.9 b/share/man/man9/taskqueue.9
index b5d620c..06be3a3 100644
--- a/share/man/man9/taskqueue.9
+++ b/share/man/man9/taskqueue.9
@@ -28,7 +28,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd Apr 30, 2005
+.Dd May 19, 2005
.Dt TASKQUEUE 9
.Os
.Sh NAME
@@ -67,6 +67,8 @@ struct task {
.Fn taskqueue_run "struct taskqueue *queue"
.Ft void
.Fn taskqueue_run_fast "struct taskqueue *queue"
+.Ft void
+.Fn taskqueue_drain "struct taskqueue *queue" "struct task *task"
.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"
@@ -159,6 +161,13 @@ and the value of
.Va ta_pending
as its second argument.
.Pp
+The
+.Fn taskqueue_drain
+function is used to wait for the task to finish.
+There is no guarantee that the task will not be
+enqueued after call to
+.Fn taskqueue_drain .
+.Pp
A convenience macro,
.Fn TASK_INIT "task" "priority" "func" "context"
is provided to initialise a
OpenPOWER on IntegriCloud