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