lib/libc_r/man/pthread_rwlockattr_setpshared.3

   1 .\" Copyright (c) 1998 Alex Nash
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/lib/libc_r/man/pthread_rwlockattr_setpshared.3,v 1.3.2.4 2001/12/17 10:08:26 ru Exp $
  26 .\"
  27 .Dd August 4, 1998
  28 .Dt PTHREAD_RWLOCKATTR_SETPSHARED 3
  29 .Os
  30 .Sh NAME
  31 .Nm pthread_rwlockattr_setpshared
  32 .Nd set the process shared attribute
  33 .Sh LIBRARY
  34 .Lb libc_r
  35 .Sh SYNOPSIS
  36 .In pthread.h
  37 .Ft int
  38 .Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int pshared"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn pthread_rwlockattr_setpshared
  42 function sets the process shared attribute of
  43 .Fa attr
  44 to the value referenced by
  45 .Fa pshared .
  46 .Fa pshared
  47 may be one of two values:
  48 .Bl -tag -width PTHREAD_PROCESS_PRIVATE
  49 .It Dv PTHREAD_PROCESS_SHARED
  50 Any thread of any process that has access to the memory where the
  51 read/write lock resides can manipulate the lock.
  52 .It Dv PTHREAD_PROCESS_PRIVATE
  53 Only threads created within the same process as the thread that
  54 initialized the read/write lock can manipulate the lock.  This is
  55 the default value.
  56 .El
  57 .Sh RETURN VALUES
  58 If successful, the
  59 .Fn pthread_rwlockattr_setpshared
  60 function will return zero.  Otherwise an error number will be returned
  61 to indicate the error.
  62 .Sh SEE ALSO
  63 .Xr pthread_rwlockattr_init 3 ,
  64 .Xr pthread_rwlockattr_setpshared 3 ,
  65 .Xr pthread_rwlock_init 3
  66 .Sh STANDARDS
  67 The
  68 .Fn pthread_rwlockattr_setpshared
  69 function is expected to conform to
  70 .St -susv2 .
  71 .Sh ERRORS
  72 .Fn pthread_rwlockattr_setpshared
  73 will fail if:
  74 .Bl -tag -width Er
  75 .It Bq Er EINVAL
  76 The value specified by
  77 .Fa attr
  78 or
  79 .Fa pshared
  80 is invalid.
  81 .El
  82 .Sh HISTORY
  83 The
  84 .Fn pthread_rwlockattr_setpshared
  85 function first appeared in
  86 .Fx 3.0 .
  87 .Sh BUGS
  88 The
  89 .Dv PTHREAD_PROCESS_SHARED
  90 attribute is not supported.