BUF_TIMELOCK (9)

Leading comments

Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. 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(s), this list of conditions and the following disclaimer as
   the first lines of this file unmodified other than the possible
   addition of one or more copyright notices.
2. Redistributions in binary for...

(The comments found at the beginning of the groff file "man9/BUF_TIMELOCK.9freebsd".)

NAME

BUF_TIMELOCK - locks a buffer

SYNOPSIS

In sys/param.h In sys/systm.h In sys/uio.h In sys/bio.h In sys/buf.h Ft int Fn BUF_TIMELOCK struct buf *bp int locktype char *wmesg int catch int timo

DESCRIPTION

The Fn BUF_TIMELOCK function locks the given buffer, and limits the amount of time it will sleep to Fa timo and OR's Fa catch into the sleep's priority. Fa wmesg is the wmesg used in the sleep.

Its arguments are:

Fa bp

The buffer to lock.

Fa locktype

Flags controlling the type of lock. See lockmgr(9) for details.

Fa wmesg

The wmesg used in any sleeps while acquiring the lock.

Fa catch

Priority OR'd into the sleep's priority.

Fa timo

The timeout for any sleeps encountered during the lock.

RETURN VALUES

A value of 0 is returned on success. See lockmgr(9) for details on non-zero return values.

SEE ALSO

buf(9), BUF_LOCK9, BUF_UNLOCK9, lockmgr(9)

AUTHORS

This manual page was written by An Chad David Aq davidc@acns.ab.ca .