lib/libc_r/man/pthread_mutexattr.3

   1 .\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
   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(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/lib/libc_r/man/pthread_mutexattr.3,v 1.2.2.7 2002/12/29 16:35:35 schweikh Exp $
  29 .Dd May 1, 2000
  30 .Dt PTHREAD_MUTEXATTR 3
  31 .Os
  32 .Sh NAME
  33 .Nm pthread_mutexattr_init ,
  34 .Nm pthread_mutexattr_destroy ,
  35 .Nm pthread_mutexattr_setprioceiling ,
  36 .Nm pthread_mutexattr_getprioceiling ,
  37 .Nm pthread_mutexattr_setprotocol ,
  38 .Nm pthread_mutexattr_getprotocol ,
  39 .Nm pthread_mutexattr_settype ,
  40 .Nm pthread_mutexattr_gettype
  41 .Nd mutex attribute operations
  42 .Sh LIBRARY
  43 .Lb libc_r
  44 .Sh SYNOPSIS
  45 .In pthread.h
  46 .Ft int
  47 .Fn pthread_mutexattr_init "pthread_mutexattr_t *attr"
  48 .Ft int
  49 .Fn pthread_mutexattr_destroy "pthread_mutexattr_t *attr"
  50 .Ft int
  51 .Fn pthread_mutexattr_setprioceiling "pthread_mutexattr_t *attr" "int prioceiling"
  52 .Ft int
  53 .Fn pthread_mutexattr_getprioceiling "pthread_mutexattr_t *attr" "int *prioceiling"
  54 .Ft int
  55 .Fn pthread_mutexattr_setprotocol "pthread_mutexattr_t *attr" "int protocol"
  56 .Ft int
  57 .Fn pthread_mutexattr_getprotocol "pthread_mutexattr_t *attr" "int *protocol"
  58 .Ft int
  59 .Fn pthread_mutexattr_settype "pthread_mutexattr_t *attr" "int type"
  60 .Ft int
  61 .Fn pthread_mutexattr_gettype "pthread_mutexattr_t *attr" "int *type"
  62 .Sh DESCRIPTION
  63 Mutex attributes are used to specify parameters to
  64 .Fn pthread_mutex_init .
  65 One attribute object can be used in multiple calls to
  66 .Fn pthread_mutex_init ,
  67 with or without modifications between calls.
  68 .Pp
  69 The
  70 .Fn pthread_mutexattr_init
  71 function initializes
  72 .Fa attr
  73 with all the default mutex attributes.
  74 .Pp
  75 The
  76 .Fn pthread_mutexattr_destroy
  77 function destroys
  78 .Fa attr .
  79 .Pp
  80 The
  81 .Fn pthread_mutexattr_set*
  82 functions set the attribute that corresponds to each function name.
  83 .Pp
  84 The
  85 .Fn pthread_mutexattr_get*
  86 functions copy the value of the attribute that corresponds to each function name
  87 to the location pointed to by the second function parameter.
  88 .Sh RETURN VALUES
  89 If successful, these functions return 0.
  90 Otherwise, an error number is returned to indicate the error.
  91 .Sh ERRORS
  92 .Fn pthread_mutexattr_init
  93 will fail if:
  94 .Bl -tag -width Er
  95 .It Bq Er ENOMEM
  96 Out of memory.
  97 .El
  98 .Pp
  99 .Fn pthread_mutexattr_destroy
 100 will fail if:
 101 .Bl -tag -width Er
 102 .It Bq Er EINVAL
 103 Invalid value for
 104 .Fa attr .
 105 .El
 106 .Pp
 107 .Fn pthread_mutexattr_setprioceiling
 108 will fail if:
 109 .Bl -tag -width Er
 110 .It Bq Er EINVAL
 111 Invalid value for
 112 .Fa attr ,
 113 or invalid value for
 114 .Fa prioceiling .
 115 .El
 116 .Pp
 117 .Fn pthread_mutexattr_getprioceiling
 118 will fail if:
 119 .Bl -tag -width Er
 120 .It Bq Er EINVAL
 121 Invalid value for
 122 .Fa attr .
 123 .El
 124 .Pp
 125 .Fn pthread_mutexattr_setprotocol
 126 will fail if:
 127 .Bl -tag -width Er
 128 .It Bq Er EINVAL
 129 Invalid value for
 130 .Fa attr ,
 131 or invalid value for
 132 .Fa protocol .
 133 .El
 134 .Pp
 135 .Fn pthread_mutexattr_getprotocol
 136 will fail if:
 137 .Bl -tag -width Er
 138 .It Bq Er EINVAL
 139 Invalid value for
 140 .Fa attr .
 141 .El
 142 .Pp
 143 .Fn pthread_mutexattr_settype
 144 will fail if:
 145 .Bl -tag -width Er
 146 .It Bq Er EINVAL
 147 Invalid value for
 148 .Fa attr ,
 149 or invalid value for
 150 .Fa type .
 151 .El
 152 .Pp
 153 .Fn pthread_mutexattr_gettype
 154 will fail if:
 155 .Bl -tag -width Er
 156 .It Bq Er EINVAL
 157 Invalid value for
 158 .Fa attr .
 159 .El
 160 .Sh SEE ALSO
 161 .Xr pthread_mutex_init 3
 162 .Sh STANDARDS
 163 .Fn pthread_mutexattr_init
 164 and
 165 .Fn pthread_mutexattr_destroy
 166 conform to
 167 .St -p1003.1-96
 168 .Pp
 169 .Fn pthread_mutexattr_setprioceiling ,
 170 .Fn pthread_mutexattr_getprioceiling ,
 171 .Fn pthread_mutexattr_setprotocol ,
 172 .Fn pthread_mutexattr_getprotocol ,
 173 .Fn pthread_mutexattr_settype ,
 174 and
 175 .Fn pthread_mutexattr_gettype
 176 conform to
 177 .St -susv2