Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pthread_mutexattr_setpshared(3c) [opensolaris man page]

pthread_mutexattr_getpshared(3C)			   Standard C Library Functions 			  pthread_mutexattr_getpshared(3C)

NAME
pthread_mutexattr_getpshared, pthread_mutexattr_setpshared - get or set process-shared attribute SYNOPSIS
cc -mt [ flag... ] file... -lpthread [ library... ] #include <pthread.h> int pthread_mutexattr_getpshared( const pthread_mutexattr_t *restrict attr, int *restrict pshared); int pthread_mutexattr_setpshared(pthread_mutexattr_t *attr, int pshared); DESCRIPTION
The pthread_mutexattr_getpshared() function obtains the value of the process-shared attribute from the attributes object referenced by attr. The pthread_mutexattr_setpshared() function is used to set the process-shared attribute in an initialized attributes object refer- enced by attr. The process-shared attribute is set to PTHREAD_PROCESS_SHARED to permit a mutex to be operated upon by any thread that has access to the memory where the mutex is allocated, even if the mutex is allocated in memory that is shared by multiple processes. If the process-shared attribute is PTHREAD_PROCESS_PRIVATE, the mutex will only be operated upon by threads created within the same process as the thread that initialized the mutex; if threads of differing processes attempt to operate on such a mutex, the behavior is undefined. The default value of the attribute is PTHREAD_PROCESS_PRIVATE. RETURN VALUES
Upon successful completion, pthread_mutexattr_getpshared() returns 0 and stores the value of the process-shared attribute of attr into the object referenced by the pshared parameter. Otherwise, an error number is returned to indicate the error. Upon successful completion, pthread_mutexattr_setpshared() returns 0. Otherwise, an error number is returned to indicate the error. ERRORS
The pthread_mutexattr_getpshared() and pthread_mutexattr_setpshared() functions may fail if: EINVAL The value specified by attr is invalid. The pthread_mutexattr_setpshared() function may fail if: EINVAL The new value specified for the attribute is outside the range of legal values for that attribute. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
pthread_create(3C), pthread_mutex_init(3C), pthread_mutexattr_init(3C), pthread_cond_init(3C), attributes(5), standards(5) SunOS 5.11 23 Mar 2005 pthread_mutexattr_getpshared(3C)

Check Out this Related Man Page

pthread_mutexattr_setpshared(3) 			     Library Functions Manual				   pthread_mutexattr_setpshared(3)

NAME
pthread_mutexattr_setpshared - Sets the process-shared attribute of a mutex attributes object. LIBRARY
DECthreads POSIX 1003.1c Library (libpthread.so) SYNOPSIS
#include <pthread.h> int pthread_mutexattr_setpshared( pthread_mutexattr_t *attr, int pshared); PARAMETERS
Address of the mutex attributes object whose process-shared attribute is to be set. Value to set in the process-shared attribute of attr. Must be the value PTHREAD_PROCESS_SHARED, to permit access to the mutex in by any thread in any process that can access the memory where the mutex object is allocated, or PTHREAD_PROCESS_PRIVATE, to permit access to the mutex only by threads in the same process as the thread that initialized the mutex object. DESCRIPTION
This routine uses the value in pshared to set the process-shared attribute in the mutex attributes object referenced by attr. The object referenced by attr must be initialized before this routine is called. The value of pshared must be either PTHREAD_PROCESS_SHARED or PTHREAD_PROCESS_PRIVATE, as defined in the pthread.h include file. Setting the process-shared attribute to PTHREAD_PROCESS_PRIVATE permits a mutex to be operated upon by threads created within the same process as the thread that initialized the mutex. If threads of differing processes attempt to operate on such a mutex, the behavior is undefined. The default value of the process-shared attribute of a mutex attributes object is PTHREAD_PROCESS_PRIVATE. Setting the process-shared attribute to PTHREAD_PROCESS_SHARED permits a mutex to be operated upon by any thread that has access to the memory where the mutex is allocated, even if the mutex is allocated in memory that is shared by multiple processes. RETURN VALUES
If an error condition occurs, this routine returns an integer value indicating the type of error. Possible return values are as follows: Successful completion. The value specified by attr is not a valid mutex attributes object, or the new value specified for the attribute is outside the range of legal values for that attribute. ERRORS
None RELATED INFORMATION
Functions: pthread_mutexattr_getpshared(3), pthread_mutexattr_init(3) Manuals: Guide to DECthreads and Programmer's Guide delim off pthread_mutexattr_setpshared(3)
Man Page