FreeBSD Man Pages

PTHREAD_MUTEXATTR(3) FreeBSD Library Functions Manual PTHREAD_MUTEXATTR(3)
NAMEpthread_mutexattr_init, pthread_mutexattr_destroy,
pthread_mutexattr_setprioceiling, pthread_mutexattr_getprioceiling,
pthread_mutexattr_setprotocol, pthread_mutexattr_getprotocol,
pthread_mutexattr_settype, pthread_mutexattr_gettype - mutex attribute
operations
LIBRARY
Reentrant C Library (libc_r, -lc_r)
SYNOPSIS#include <pthread.h>
intpthread_mutexattr_init(pthread_mutexattr_t*attr);
intpthread_mutexattr_destroy(pthread_mutexattr_t*attr);
intpthread_mutexattr_setprioceiling(pthread_mutexattr_t*attr,
intprioceiling);
intpthread_mutexattr_getprioceiling(pthread_mutexattr_t*attr,
int*prioceiling);
intpthread_mutexattr_setprotocol(pthread_mutexattr_t*attr, intprotocol);
intpthread_mutexattr_getprotocol(pthread_mutexattr_t*attr, int*protocol);
intpthread_mutexattr_settype(pthread_mutexattr_t*attr, inttype);
intpthread_mutexattr_gettype(pthread_mutexattr_t*attr, int*type);
DESCRIPTION
Mutex attributes are used to specify parameters to pthread_mutex_init().
One attribute object can be used in multiple calls to
pthread_mutex_init(), with or without modifications between calls.
The pthread_mutexattr_init() function initializes attr with all the
default mutex attributes.
The pthread_mutexattr_destroy() function destroys attr.
The pthread_mutexattr_set*() functions set the attribute that corresponds
to each function name.
The pthread_mutexattr_get*() functions copy the value of the attribute
that corresponds to each function name to the location pointed to by the
second function parameter.
RETURN VALUES
If successful, these functions return 0. Otherwise, an error number is
returned to indicate the error.
ERRORS
The pthread_mutexattr_init() function will fail if:
[ENOMEM] Out of memory.
The pthread_mutexattr_destroy() function will fail if:
[EINVAL] Invalid value for attr.
The pthread_mutexattr_setprioceiling() function will fail if:
[EINVAL] Invalid value for attr, or invalid value for
prioceiling.
The pthread_mutexattr_getprioceiling() function will fail if:
[EINVAL] Invalid value for attr.
The pthread_mutexattr_setprotocol() function will fail if:
[EINVAL] Invalid value for attr, or invalid value for protocol.
The pthread_mutexattr_getprotocol() function will fail if:
[EINVAL] Invalid value for attr.
The pthread_mutexattr_settype() function will fail if:
[EINVAL] Invalid value for attr, or invalid value for type.
The pthread_mutexattr_gettype() function will fail if:
[EINVAL] Invalid value for attr.
SEE ALSOpthread_mutex_init(3)STANDARDS
The pthread_mutexattr_init() and pthread_mutexattr_destroy() functions
conform to ISO/IEC 9945-1:1996 (``POSIX.1'')
The pthread_mutexattr_setprioceiling(),
pthread_mutexattr_getprioceiling(), pthread_mutexattr_setprotocol(),
pthread_mutexattr_getprotocol(), pthread_mutexattr_settype(), and
pthread_mutexattr_gettype() functions conform to Version 2 of the Single
UNIX Specification (``SUSv2'')
FreeBSD 11.0-PRERELEASE May 1, 2000 FreeBSD 11.0-PRERELEASE