ADC Home > Reference Library > Reference > Mac OS X > Mac OS X Man Pages

 

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).



PTHREAD_COND_TIMEDWAI... BSD Library Functions Manual PTHREAD_COND_TIMEDWAI...

NAME
     pthread_cond_timedwait -- wait on a condition variable for a specific amount of time

SYNOPSIS
     #include <pthread.h>

     int
     pthread_cond_timedwait(pthread_cond_t *restrict cond, pthread_mutex_t *restrict mutex,
         const struct timespec *restrict abstime);

DESCRIPTION
     The pthread_cond_timedwait() function atomically blocks the current thread waiting on the condition
     variable specified by cond and unblocks the mutex specified by mutex.  The waiting thread unblocks only
     after another thread calls pthread_cond_signal(3), or pthread_cond_broadcast(3) with the same condition
     variable, or if the system time reaches the time specified in abstime, and the current thread reac-quires reacquires
     quires the lock on mutex.

RETURN VALUES
     If successful, the pthread_cond_timedwait() function will return zero.  Otherwise, an error number will
     be returned to indicate the error.

ERRORS
     pthread_cond_timedwait() will fail if:

     [EINVAL]           The value specified by cond, mutex or abstime is invalid.

     [ETIMEDOUT]        The system time has reached or exceeded the time specified in abstime.

SEE ALSO
     pthread_cond_broadcast(3), pthread_cond_destroy(3), pthread_cond_init(3), pthread_cond_signal(3),
     pthread_cond_wait(3)

STANDARDS
     pthread_cond_timedwait() conforms to ISO/IEC 9945-1:1996 (``POSIX.1'').

BSD                              July 28, 1998                             BSD

Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.