.\" $NetBSD: workqueue_create.9,v 1.3 2005/11/24 22:18:03 wiz Exp $ .\" .\" Copyright (c)2005 YAMAMOTO Takashi, .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" ------------------------------------------------------------ .Dd November 24, 2005 .Dt WORKQUEUE_CREATE 9 .Os .\" ------------------------------------------------------------ .Sh NAME .Nm workqueue_create .Nd Create a workqueue .\" ------------------------------------------------------------ .Sh SYNOPSIS .In sys/workqueue.h .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .Ft int .Fn workqueue_create \ "struct workqueue **wqp" "const char *name" \ "void (*func)(struct work *, void *)" "void *arg" \ "int prio" "int ipl" "int flags" .\" ------------------------------------------------------------ .Sh DESCRIPTION .Fn workqueue_create creates a workqueue. It takes the following arguments. .Bl -tag -width flags .It Fa wqp Specify where to store the created workqueue. .It Fa func The function to be called for each .Fa work . .It Fa arg An argument to be passed as a second argument of .Fa func . .It Fa name The name of the workqueue. .It Fa prio The process priority to be used when sleeping to wait requests. .It Fa ipl The highest IPL at which this workqueue is used. .It Fa flags Should be 0. .El .\" ------------------------------------------------------------ .Sh RETURN VALUES .Fn workqueue_create returns 0 on success. Otherwise, it returns an .Xr errno 2 . .\" ------------------------------------------------------------ .Sh SEE ALSO .Xr errno 2 , .Xr intro 9 , .Xr ltsleep 9 , .Xr workqueue 9 .\" ------------------------------------------------------------ .Sh BUGS Currently .Fa ipl is ignored and .Fn splhigh is always used to protect the queue.