6/share/man/man3/pthread_mutex_timedlock.3

   1 .\" Copyright (c) 2003 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$
  26 .\"
  27 .Dd December 30, 2003
  28 .Dt PTHREAD_MUTEX_TIMEDLOCK 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_mutex_timedlock
  32 .Nd lock a mutex without blocking indefinitely
  33 .Sh LIBRARY
  34 .Lb libpthread
  35 .Lb libthr
  36 .Sh SYNOPSIS
  37 .In pthread.h
  38 .In time.h
  39 .Ft int
  40 .Fn pthread_mutex_timedlock "pthread_mutex_t *mutex" "const struct timespec *abs_timeout"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn pthread_mutex_timedlock
  44 function will lock
  45 .Fa mutex .
  46 If it is already locked the calling thread will block until
  47 the mutex becomes available or
  48 the timeout,
  49 specified by abs_timeout,
  50 expires.
  51 The time of the timeout is an absolute time and
  52 is not relative to the current time.
  53 .Sh RETURN VALUES
  54 If successful,
  55 .Fn pthread_mutex_timedlock
  56 will return zero, otherwise an error number will be returned to
  57 indicate the error.
  58 .Sh ERRORS
  59 The
  60 .Fn pthread_mutex_timedlock
  61 function will fail if:
  62 .Bl -tag -width Er
  63 .It Bq Er EINVAL
  64 The
  65 .Fa mutex
  66 was created with the protocol attribute having the
  67 value PTHREAD_PRIO_PROTECT and
  68 the calling thread's priority is higher than the
  69 mutex's current priority ceiling.
  70 .It Bq Er EINVAL
  71 The process or thread would have blocked, and
  72 .Fa abs_timeout
  73 specified a nanosecond value less than zero or
  74 greater than or equal to 1 billion.
  75 .It Bq Er EINVAL
  76 The
  77 .Fa mutex
  78 parameter is invalid.
  79 .It Bq Er ETIMEDOUT
  80 The
  81 .Fa mutex
  82 could not be locked before the timeout expired.
  83 .It Bq Er EAGAIN
  84 The
  85 .Fa mutex
  86 could not be acquired because the
  87 maximum number of recursive locks for the
  88 .Fa mutex
  89 has been exceeded.
  90 .It Bq Er EDEADLK
  91 The current thread already owns the
  92 .Fa mutex .
  93 .El
  94 .Sh SEE ALSO
  95 .Xr pthread_mutex_destroy 3 ,
  96 .Xr pthread_mutex_init 3 ,
  97 .Xr pthread_mutex_lock 3 ,
  98 .Xr pthread_mutex_trylock 3 ,
  99 .Xr pthread_mutex_unlock 3
 100 .Sh STANDARDS
 101 The
 102 .Fn pthread_mutex_timedlock
 103 function is expected to conform to
 104 .St -p1003.1-96 .