tis_mutex_lock

Locks an unlocked mutex.

Syntax

tis_mutex_lock( mutex );

Argument Data Type Access

mutex opaque pthread_mutex_t read

C Binding

#include 


int
tis_mutex_lock (
            pthread_mutex_t   *mutex);

Arguments

mutex: Address of the mutex (passed by reference) to be locked.

Description

This routine locks a mutex. A deadlock can result if the current owner of a mutex calls this routine in an attempt to lock the mutex a second time. (The deadlock is not detected or reported.)

In a threaded environment, the thread that has locked a mutex becomes its current owner and remains the owner until the same thread has unlocked it. This routine returns with the mutex in the locked state and with the current thread as the mutex's current owner.

Return Values

If an error condition occurs, this routine returns an integer value indicating the type of error. Possible return values are as follows:

Return Description

0 Successful completion. [EINVAL] The value specified by mutex is invalid. [EDEADLK] A deadlock condition is detected.

Associated Routines

   tis_mutex_destroy
   tis_mutex_init
   tis_mutex_trylock
   tis_mutex_unlock