1.\" 2.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice(s), this list of conditions and the following disclaimer as 9.\" the first lines of this file unmodified other than the possible 10.\" addition of one or more copyright notices. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice(s), this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 16.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 18.\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY 19.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 25.\" DAMAGE. 26.\" 27.Dd July 9, 2001 28.Dt BUF_TIMELOCK 9 29.Os 30.Sh NAME 31.Nm BUF_TIMELOCK 32.Nd "locks a buffer" 33.Sh SYNOPSIS 34.In sys/param.h 35.In sys/systm.h 36.In sys/uio.h 37.In sys/bio.h 38.In sys/buf.h 39.Ft int 40.Fn BUF_TIMELOCK "struct buf *bp" "int locktype" "char *wmesg" "int catch" "int timo" 41.Sh DESCRIPTION 42The 43.Fn BUF_TIMELOCK 44function locks the given buffer, and limits the amount of time it 45will sleep to 46.Fa timo 47and OR's 48.Fa catch 49into the sleep's priority. 50.Fa wmesg 51is the wmesg used in the sleep. 52.Pp 53Its arguments are: 54.Bl -tag -width ".Fa locktype" 55.It Fa bp 56The buffer to lock. 57.It Fa locktype 58Flags controlling the type of lock. 59See 60.Xr lockmgr 9 61for details. 62.It Fa wmesg 63The wmesg used in any sleeps while acquiring the lock. 64.It Fa catch 65Priority OR'd into the sleep's priority. 66.It Fa timo 67The timeout for any sleeps encountered during the lock. 68.El 69.Sh RETURN VALUES 70A value of 0 is returned on success. 71See 72.Xr lockmgr 9 73for details on non-zero return values. 74.Sh SEE ALSO 75.Xr buf 9 , 76.Xr BUF_LOCK 9 , 77.Xr BUF_UNLOCK 9 , 78.Xr lockmgr 9 79.Sh AUTHORS 80This manual page was written by 81.An Chad David Aq Mt davidc@acns.ab.ca . 82