This version of this document is no longer maintained. For the latest documentation, see http://www.qnx.com/developers/docs.

pthread_mutex_timedlock()

Attempt to lock mutex

Synopsis:

#include <pthread.h>
#include <time.h>

int pthread_mutex_timedlock( 
                  pthread_mutex_t * mutex,
                  const struct timespec * abs_timeout );

Arguments:

mutex: The mutex that you want to lock.
abs_timeout: A pointer to a timespec structure that specifies the maximum time to wait to lock the mutex, expressed as an absolute time.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

The pthread_mutex_timedlock() function is called to lock the mutex object referenced by mutex. If the mutex is already locked, the calling thread blocks until the mutex becomes available as in the pthread_mutex_lock function. If the mutex can't be locked without waiting for another thread to unlock the mutex, the wait is terminated when the specified timeout expires.

The timeout expires when the absolute time specified by abs_timeout passes, as measured by the clock on which timeouts are based (i.e., when the value of that clock equals or exceeds abs_timeout), or if the absolute time specified by abs_timeout has already been passed at the time of the call.

The timeout is based on the CLOCK_REALTIME clock. The timespec datatype is defined in the <time.h> header.

If the mutex can be locked immediately, the validity of the abs_timeout parameter isn't checked, and the function won't fail with a timeout.

As a consequence of the priority inheritance rules (for mutexes initialized with the PRIO_INHERIT protocol), if a timed mutex wait is terminated because its timeout expires, the priority of the owner of the mutex is adjusted as necessary to reflect the fact that this thread is no longer among the threads waiting for the mutex.

Returns:

Zero on success, or an error number to indicate the error.

Errors:

EAGAIN: The mutex couldn't be acquired because the maximum number of recursive locks for the mutex has been exceeded.
EDEADLK: The current thread already owns the mutex.
EINVAL: The mutex was created with the protocol attribute having the value PTHREAD_PRIO_PROTECT and the calling thread's priority is higher than the mutex' current priority ceiling; the process or thread would have blocked, and the abs_timeout parameter specified a nanoseconds field value less than zero or greater than or equal to 1000 million; or the value specified by mutex doesn't refer to an initialized mutex object.
ETIMEDOUT: The mutex couldn't be locked before the specified timeout expired.

Classification:

POSIX 1003.1 THR TMO

Safety:
Cancellation point	No
Interrupt handler	No
Signal handler	Yes
Thread	Yes