pthreads/pthread_cond_timedwait.3

   1 .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
   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 .\" 3. Neither the name of the author nor the names of any co-contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/lib/libc_r/man/pthread_cond_timedwait.3,v 1.8.2.6 2001/08/17 15:42:51 ru Exp $
  29 .\"
  30 .Dd July 28, 1998
  31 .Dt PTHREAD_COND_TIMEDWAIT 3
  32 .Os
  33 .Sh NAME
  34 .Nm pthread_cond_timedwait
  35 .Nd "wait on a condition variable for a specific amount of time"
  36 .Sh SYNOPSIS
  37 .Fd #include <pthread.h>
  38 .Ft int
  39 .Fn pthread_cond_timedwait "pthread_cond_t *cond" "pthread_mutex_t *mutex" "const struct timespec *abstime"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn pthread_cond_timedwait
  43 function atomically blocks the current thread waiting on the condition
  44 variable specified by
  45 .Fa cond ,
  46 and unblocks the mutex specified by
  47 .Fa mutex .
  48 The waiting thread unblocks only after another thread calls
  49 .Xr pthread_cond_signal 3 ,
  50 or
  51 .Xr pthread_cond_broadcast 3
  52 with the same condition variable, or if the system time reaches the
  53 time specified in
  54 .Fa abstime ,
  55 and the current thread reacquires the lock on
  56 .Fa mutex .
  57 .Sh RETURN VALUES
  58 If successful, the
  59 .Fn pthread_cond_timedwait
  60 function will return zero.
  61 Otherwise an error number will be returned to
  62 indicate the error.
  63 .Sh ERRORS
  64 .Fn pthread_cond_timedwait
  65 will fail if:
  66 .Bl -tag -width Er
  67 .It Bq Er EINVAL
  68 The value specified by
  69 .Fa cond ,
  70 .Fa mutex
  71 or
  72 .Fa abstime
  73 is invalid.
  74 .It Bq Er ETIMEDOUT
  75 The system time has reached or exceeded the time specified in
  76 .Fa abstime .
  77 .El
  78 .Sh SEE ALSO
  79 .Xr pthread_cond_broadcast 3 ,
  80 .Xr pthread_cond_destroy 3 ,
  81 .Xr pthread_cond_init 3 ,
  82 .Xr pthread_cond_signal 3 ,
  83 .Xr pthread_cond_wait 3
  84 .Sh STANDARDS
  85 .Fn pthread_cond_timedwait
  86 conforms to
  87 .St -p1003.1-96 .