logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface

Application Usage

       None.

Description

       The  pthread_mutexattr_getpshared()  function shall obtain the value of the process-shared attribute from
       the attributes object referenced by attr.

       The pthread_mutexattr_setpshared() function shall set the  process-shared  attribute  in  an  initialized
       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.  See  Section2.9.9, SynchronizationObjectCopiesandAlternativeMappings  for  further  requirements.  The  default  value  of  the   attribute   shall   be
       PTHREAD_PROCESS_PRIVATE.

       The  behavior  is undefined if the value specified by the attr argument to pthread_mutexattr_getpshared()
       or pthread_mutexattr_setpshared() does not refer to an initialized mutex attributes object.

Errors

       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.

       These functions shall not return an error code of [EINTR].

       Thefollowingsectionsareinformative.

Examples

       None.

Future Directions

       None.

Name

       pthread_mutexattr_getpshared, pthread_mutexattr_setpshared — get and set the process-shared attribute

Prolog

       This  manual  page  is part of the POSIX Programmer's Manual.  The Linux implementation of this interface
       may differ (consult the corresponding Linux manual page for details of Linux behavior), or the  interface
       may not be implemented on Linux.

Rationale

       If   an   implementation   detects   that   the   value   specified   by    the    attr    argument    to
       pthread_mutexattr_getpshared()  or  pthread_mutexattr_setpshared() does not refer to an initialized mutex
       attributes object, it is recommended that the function should fail and report an [EINVAL] error.

Return Value

       Upon successful completion, pthread_mutexattr_setpshared() shall return zero; otherwise, an error  number
       shall be returned to indicate the error.

       Upon  successful  completion, pthread_mutexattr_getpshared() shall return zero and store the value of the
       process-shared attribute of attr into the object referenced by the pshared parameter. Otherwise, an error
       number shall be returned to indicate the error.

See Also

pthread_cond_destroy(), pthread_create(), pthread_mutex_destroy(), pthread_mutexattr_destroy()

       The Base Definitions volume of POSIX.1‐2017, <pthread.h>

Synopsis

       #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);