The Single UNIX ® Specification, Version 2
Copyright © 1997 The Open Group

 NAME

pthread_condattr_getpshared, pthread_condattr_setpshared - get and set the process-shared condition variable attributes

 SYNOPSIS



#include <pthread.h>

int pthread_condattr_getpshared(const pthread_condattr_t *attr,
    int *pshared);
int pthread_condattr_setpshared(pthread_condattr_t *attr,
    int pshared);

 DESCRIPTION

The pthread_condattr_getpshared() function obtains the value of the process-shared attribute from the attributes object referenced by attr. The pthread_condattr_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 condition variable to be operated upon by any thread that has access to the memory where the condition variable is allocated, even if the condition variable is allocated in memory that is shared by multiple processes. If the process-shared attribute is PTHREAD_PROCESS_PRIVATE, the condition variable will only be operated upon by threads created within the same process as the thread that initialised the condition variable; if threads of differing processes attempt to operate on such a condition variable, the behaviour is undefined. The default value of the attribute is PTHREAD_PROCESS_PRIVATE.

Additional attributes, their default values, and the names of the associated functions to get and set those attribute values are implementation-dependent.

 RETURN VALUE

If successful, the pthread_condattr_setpshared() function returns zero. Otherwise, an error number is returned to indicate the error.

If successful, the pthread_condattr_getpshared() function 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.

 ERRORS

The pthread_condattr_getpshared() and pthread_condattr_setpshared() functions may fail if:
[EINVAL]
The value specified by attr is invalid.

The pthread_condattr_setpshared() function may fail 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].

 EXAMPLES

None.

 APPLICATION USAGE

None.

 FUTURE DIRECTIONS

None.

 SEE ALSO

pthread_condattr_init(), pthread_create(), pthread_mutex_init(), pthread_cond_init(), <pthread.h>.

DERIVATION

Derived from the POSIX Threads Extension (1003.1c-1995)

UNIX ® is a registered Trademark of The Open Group.
Copyright © 1997 The Open Group
[ Main Index | XSH | XCU | XBD | XCURSES | XNS ]