lib/libpthread/pthread_rwlock_timedwrlock.3

   1 .\" Copyright (c) 2004 Michael Telahun Makonnen
   2 .\" 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, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man3/pthread_rwlock_timedwrlock.3,v 1.3 2007/10/22 10:08:00 ru Exp $
  26 .\"
  27 .Dd July 10, 2009
  28 .Dt PTHREAD_RWLOCK_TIMEDWRLOCK 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_rwlock_timedwrlock
  32 .Nd "acquire a read-write lock for writing or give up after a specified period"
  33 .Sh LIBRARY
  34 .Lb libpthread
  35 .Sh SYNOPSIS
  36 .In pthread.h
  37 .Ft int
  38 .Fn pthread_rwlock_timedwrlock "pthread_rwlock_t *rwlock" "const struct timespec *abs_timeout"
  39 .Sh DESCRIPTION
  40 This function acquires a write lock on the read-write lock
  41 .Fa rwlock .
  42 However, if the lock cannot be
  43 acquired without waiting for another thread to
  44 unlock the lock,
  45 this wait shall be terminated when
  46 .Fa abs_timeout
  47 expires.
  48 .Pp
  49 If the thread should be interrupted by a signal,
  50 the
  51 .Fn pthread_rwlock_timedwrlock
  52 function will be automatically restarted after the thread returns from
  53 the signal handler.
  54 .Pp
  55 The calling thread may deadlock if
  56 at the time the call is made it holds
  57 .Fa rwlock .
  58 The results are undefined if this function is called with
  59 an uninitialized read-write lock.
  60 .Sh IMPLEMENTATION NOTES
  61 To prevent writer starvation, writers are favored over readers.
  62 .Sh RETURN VALUES
  63 If successful, the
  64 .Fn pthread_rwlock_timedwrlock
  65 function will return zero.
  66 Otherwise, an error number will be returned to indicate the error.
  67 .Pp
  68 This function shall not return an error code of
  69 .Er EINTR .
  70 .Sh ERRORS
  71 The
  72 .Fn pthread_rwlock_timedwrlock
  73 function shall fail if:
  74 .Bl -tag -width Er
  75 .It Bq Er ETIMEDOUT
  76 The lock could not be acquired before the specified timeout expired.
  77 .El
  78 .Pp
  79 The
  80 .Fn pthread_rwlock_timedwrlock
  81 function may fail if:
  82 .Bl -tag -width Er
  83 .It Bq Er EDEADLK
  84 The calling thread already holds
  85 .Fa rwlock .
  86 .It Bq Er EINVAL
  87 The value specified by
  88 .Fa rwlock
  89 does not refer to an initialized read-write lock object,
  90 or the
  91 .Fa abs_timeout
  92 nanosecond value is less than zero or
  93 greater than or equal to 1 billion.
  94 .El
  95 .Sh SEE ALSO
  96 .Xr pthread_rwlock_init 3 ,
  97 .Xr pthread_rwlock_timedrdlock 3 ,
  98 .Xr pthread_rwlock_unlock 3
  99 .Sh STANDARDS
 100 The
 101 .Fn pthread_rwlock_timedwrlock
 102 function is expected to conform to
 103 .St -p1003.1-96 .
 104 .Sh HISTORY
 105 The
 106 .Fn pthread_rwlock_timedwrlock
 107 function first appeared in
 108 .Fx 5.2 .