share/man/man3/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$
  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 libpthread
  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 The
  93 .Fn pthread_mutexattr_init
  94 function will fail if:
  95 .Bl -tag -width Er
  96 .It Bq Er ENOMEM
  97 Out of memory.
  98 .El
  99 .Pp
 100 The
 101 .Fn pthread_mutexattr_destroy
 102 function will fail if:
 103 .Bl -tag -width Er
 104 .It Bq Er EINVAL
 105 Invalid value for
 106 .Fa attr .
 107 .El
 108 .Pp
 109 The
 110 .Fn pthread_mutexattr_setprioceiling
 111 function will fail if:
 112 .Bl -tag -width Er
 113 .It Bq Er EINVAL
 114 Invalid value for
 115 .Fa attr ,
 116 or invalid value for
 117 .Fa prioceiling .
 118 .El
 119 .Pp
 120 The
 121 .Fn pthread_mutexattr_getprioceiling
 122 function will fail if:
 123 .Bl -tag -width Er
 124 .It Bq Er EINVAL
 125 Invalid value for
 126 .Fa attr .
 127 .El
 128 .Pp
 129 The
 130 .Fn pthread_mutexattr_setprotocol
 131 function will fail if:
 132 .Bl -tag -width Er
 133 .It Bq Er EINVAL
 134 Invalid value for
 135 .Fa attr ,
 136 or invalid value for
 137 .Fa protocol .
 138 .El
 139 .Pp
 140 The
 141 .Fn pthread_mutexattr_getprotocol
 142 function will fail if:
 143 .Bl -tag -width Er
 144 .It Bq Er EINVAL
 145 Invalid value for
 146 .Fa attr .
 147 .El
 148 .Pp
 149 The
 150 .Fn pthread_mutexattr_settype
 151 function will fail if:
 152 .Bl -tag -width Er
 153 .It Bq Er EINVAL
 154 Invalid value for
 155 .Fa attr ,
 156 or invalid value for
 157 .Fa type .
 158 .El
 159 .Pp
 160 The
 161 .Fn pthread_mutexattr_gettype
 162 function will fail if:
 163 .Bl -tag -width Er
 164 .It Bq Er EINVAL
 165 Invalid value for
 166 .Fa attr .
 167 .El
 168 .Sh SEE ALSO
 169 .Xr pthread_mutex_init 3
 170 .Sh STANDARDS
 171 The
 172 .Fn pthread_mutexattr_init
 173 and
 174 .Fn pthread_mutexattr_destroy
 175 functions conform to
 176 .St -p1003.1-96
 177 .Pp
 178 The
 179 .Fn pthread_mutexattr_setprioceiling ,
 180 .Fn pthread_mutexattr_getprioceiling ,
 181 .Fn pthread_mutexattr_setprotocol ,
 182 .Fn pthread_mutexattr_getprotocol ,
 183 .Fn pthread_mutexattr_settype ,
 184 and
 185 .Fn pthread_mutexattr_gettype
 186 functions conform to
 187 .St -susv2