Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pthread_mutexattr_destroy(3t) [hpux man page]

pthread_mutexattr_init(3T)												pthread_mutexattr_init(3T)

NAME
pthread_mutexattr_init(), pthread_mutexattr_destroy() - initialize or destroy a mutex attributes object SYNOPSIS
PARAMETERS
attr Pointer to the mutex attributes object to be initialized or destroyed. DESCRIPTION
initializes the mutex attributes object attr with the default values for all attributes. The attributes object describes a mutex in detail and is passed to the mutex initialization function. When a mutex attributes object is used to initialize a mutex, the values of the individual attributes determine the characteristics of the new mutex. Attributes objects act like additional parameters to object initialization. A single attributes object can be used in multiple calls to the function When a mutex is initialized with an attributes object, the attributes are, in effect, copied into the mutex. Consequently, any change to the attributes object will not affect any previously initialized mutexes. Once all mutexes needing a specific attributes object have been initialized, the attributes object is no longer needed. The mutex attributes and their default values are: The default value is The default value is If an initialized mutex attributes object is reinitialized, undefined behavior results. destroys the mutex attributes object attr. The destroyed mutex attributes object ceases to exist and its resources are reclaimed. Using attr after it has been destroyed results in undefined behavior. A destroyed mutex attributes object can be reinitialized using the func- tion. Mutexes that have been already initialized using this attributes object are not affected by the destruction of the mutex attributes object. RETURN VALUE
Upon successful completion, and return zero. Otherwise, an error number is returned to indicate the error (the variable is not set). ERRORS
For each of the following conditions, if the condition is detected, the and functions return the corresponding error number: [ENOMEM] There is insufficient memory available in which to initialize attr. [EINVAL] The value specified by attr is invalid. AUTHOR
and were derived from the IEEE POSIX P1003.1c standard. SEE ALSO
pthread_create(3T), pthread_mutexattr_getpshared(3T), pthread_mutexattr_setpshared(3T), pthread_mutexattr_gettype(3T), pthread_mutex- attr_settype(3T), pthread_mutex_init(3T). STANDARDS CONFORMANCE
Pthread Library pthread_mutexattr_init(3T)

Check Out this Related Man Page

pthread_mutex_init(3T)													    pthread_mutex_init(3T)

NAME
pthread_mutex_init(), pthread_mutex_destroy() - initialize or destroy a mutex SYNOPSIS
PARAMETERS
mutex Pointer to the mutex to be initialized or destroyed. attr Pointer to the attributes object that defines the characteristics of the mutex to be initialized. If the pointer is NULL, default attributes are used. DESCRIPTION
The function initializes the mutex referenced by mutex with the attributes attr. If the parameter attr is NULL, the default mutex attributes are used. See pthread_mutexattr_init(3T) for a list of default mutex attributes. After successful initialization, the mutex is initialized, unlocked, and ready to be used in mutex operations. A mutex should be initialized only once or the resulting behavior is undefined. The function provides a way to ensure that a mutex is initialized only once. The macro can be used to initialize mutexes that are statically allocated. These mutexes will be initialized with default attributes. The function does not need to be called for statically initialized mutexes. If the process-shared attribute in the mutex attributes object referenced by attr is defined as the mutex must be allocated such that the processes sharing the mutex have access to it. This may be done through the memory-mapping functions (see mmap(2)) or the shared memory functions (see shmget(2)). The function destroys the mutex referenced by mutex. This function may set mutex to an invalid value. The destroyed mutex can be reini- tialized using the function If the mutex is used after destruction in any mutex call, the resulting behavior is undefined. A mutex should be destroyed only when it is unlocked. Destroying a mutex that is currently being used results in undefined behavior. RETURN VALUE
Upon successful completion, and return zero. Otherwise, an error number is returned to indicate the error (the variable is not set). ERRORS
If any of the following occur, the function returns the corresponding error number: The necessary resources (other than memory) to initialize mutex were not available. mutex is an already initialized mutex. However, getting for reinitializing the mutex cannot be expected all the time since the behavior of reinitializing the mutex is undefined. mutex points to an illegal address. The value specified by mutex or attr is invalid. There is insufficient memory available in which to initialize mutex. The caller does not have the necessary permission to perform the mutex initialization. If any of the following occur, the function returns the corresponding error number: mutex is currently locked or in use by another thread. mutex is not a valid mutex. WARNINGS
The space for the mutex must be allocated before calling Undefined behavior will result if the process-shared attribute of attr is and the space allocated for the mutex is not accessible to cooperating threads. AUTHOR
and were derived from the IEEE POSIX P1003.1c standard. SEE ALSO
pthread_mutex_lock(3T), pthread_mutex_trylock(3T), pthread_mutex_unlock(3T). STANDARDS CONFORMANCE
Pthread Library pthread_mutex_init(3T)
Man Page