[ Next Article | Previous Article | Book Contents | Library Home | Legal | Search ]
Base Operating System and Extensions Technical Reference, Volume 1

pthread_mutexattr_getpshared or pthread_mutexattr_setpshared Subroutine

Purpose

Sets and gets process-shared attribute.

Library

Threads Library (libpthreads.a)

Syntax

#include <pthread.h>
int pthread_mutexattr_getpshared (attr, pshared)
const pthread_mutexattr_t *attr;
int *pshared;
int pthread_mutexattr_setpshared (attr, pshared)
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 initialised attributes object referenced 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 initialised the mutex; if threads of differing processes attempt to operate on such a mutex, the behaviour is undefined. The default value of the attribute is PTHREAD_PROCESS_PRIVATE.

Parameters

attr Specifies the mutex attributes object.
pshared Points to where the pshared attribute value will be stored.

Return Values

Upon successful completion, pthread_mutexattr_setpshared returns zero. Otherwise, an error number is returned to indicate the error.

Upon successful completion, pthread_mutexattr_getpshared returns zero 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.

Error Codes

The pthread_mutexattr_getpshared and pthread_mutexattr_setpshared functions will fail if:

EINVAL The value specified by attr is invalid.

The pthread_mutexattr_setpshared function willfail if:

EINVAL The new value specified for the attribute is outside the range of legal values for that attribute.

These functions will not return an error code of EINTR.

Implementation Specifics

This subroutine is part of the Base Operating System (BOS) Runtime.

Related Information

The pthread_mutexattr_init subroutine.

Advanced Attributes in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.

Threads Library Options and Threads Library Quick Reference in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.


[ Next Article | Previous Article | Book Contents | Library Home | Legal | Search ]