178 lines
4.7 KiB
Groff
178 lines
4.7 KiB
Groff
.\" Copyright (C) 2000 Jason Evans <jasone@freebsd.org>.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice(s), this list of conditions and the following disclaimer as
|
|
.\" the first lines of this file unmodified other than the possible
|
|
.\" addition of one or more copyright notices.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice(s), this list of conditions and the following disclaimer in
|
|
.\" the documentation and/or other materials provided with the
|
|
.\" distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
|
|
.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
|
|
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
|
|
.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
|
.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
|
.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
|
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.Dd May 1, 2000
|
|
.Dt PTHREAD_MUTEXATTR 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm pthread_mutexattr_init ,
|
|
.Nm pthread_mutexattr_destroy ,
|
|
.Nm pthread_mutexattr_setprioceiling ,
|
|
.Nm pthread_mutexattr_getprioceiling ,
|
|
.Nm pthread_mutexattr_setprotocol ,
|
|
.Nm pthread_mutexattr_getprotocol ,
|
|
.Nm pthread_mutexattr_settype ,
|
|
.Nm pthread_mutexattr_gettype
|
|
.Nd mutex attribute operations
|
|
.Sh LIBRARY
|
|
.Lb libc_r
|
|
.Sh SYNOPSIS
|
|
.Fd #include <pthread.h>
|
|
.Ft int
|
|
.Fn pthread_mutexattr_init "pthread_mutexattr_t *attr"
|
|
.Ft int
|
|
.Fn pthread_mutexattr_destroy "pthread_mutexattr_t *attr"
|
|
.Ft int
|
|
.Fn pthread_mutexattr_setprioceiling "pthread_mutexattr_t *attr" "int prioceiling"
|
|
.Ft int
|
|
.Fn pthread_mutexattr_getprioceiling "pthread_mutexattr_t *attr" "int *prioceiling"
|
|
.Ft int
|
|
.Fn pthread_mutexattr_setprotocol "pthread_mutexattr_t *attr" "int protocol"
|
|
.Ft int
|
|
.Fn pthread_mutexattr_getprotocol "pthread_mutexattr_t *attr" "int *protocol"
|
|
.Ft int
|
|
.Fn pthread_mutexattr_settype "pthread_mutexattr_t *attr" "int type"
|
|
.Ft int
|
|
.Fn pthread_mutexattr_gettype "pthread_mutexattr_t *attr" "int *type"
|
|
.Sh DESCRIPTION
|
|
Mutex attributes are used to specify parameters to
|
|
.Fn pthread_mutex_init .
|
|
One attribute object can be used in multiple calls to
|
|
.Fn pthread_mutex_init ,
|
|
with or without modifications between calls.
|
|
.Pp
|
|
The
|
|
.Fn pthread_mutexattr_init
|
|
function initializes
|
|
.Fa attr
|
|
with all the default mutex attributes.
|
|
.Pp
|
|
The
|
|
.Fn pthread_mutexattr_destroy
|
|
function destroys
|
|
.Fa attr .
|
|
.Pp
|
|
The
|
|
.Fn pthread_mutexattr_set*
|
|
functions set the attribute that corresponds to each function name.
|
|
.Pp
|
|
The
|
|
.Fn pthread_mutexattr_get*
|
|
functions copy the value of the attribute that corresponds to each function name
|
|
to the location pointed to by the second function parameter.
|
|
.Sh RETURN VALUES
|
|
If successful, these functions return 0.
|
|
Otherwise, an error number is returned to indicacte the error.
|
|
.Sh ERRORS
|
|
.Fn pthread_mutexattr_init
|
|
will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er ENOMEM
|
|
Out of memory.
|
|
.El
|
|
.Pp
|
|
.Fn pthread_mutexattr_destroy
|
|
will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
Invalid value for
|
|
.Fa attr .
|
|
.El
|
|
.Pp
|
|
.Fn pthread_mutexattr_setprioceiling
|
|
will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
Invalid value for
|
|
.Fa attr ,
|
|
or invalid value for
|
|
.Fa prioceiling .
|
|
.El
|
|
.Pp
|
|
.Fn pthread_mutexattr_getprioceiling
|
|
will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
Invalid value for
|
|
.Fa attr .
|
|
.El
|
|
.Pp
|
|
.Fn pthread_mutexattr_setprotocol
|
|
will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
Invalid value for
|
|
.Fa attr ,
|
|
or invalid value for
|
|
.Fa protocol .
|
|
.El
|
|
.Pp
|
|
.Fn pthread_mutexattr_getprotocol
|
|
will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
Invalid value for
|
|
.Fa attr .
|
|
.El
|
|
.Pp
|
|
.Fn pthread_mutexattr_settype
|
|
will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
Invalid value for
|
|
.Fa attr ,
|
|
or invalid value for
|
|
.Fa type .
|
|
.El
|
|
.Pp
|
|
.Fn pthread_mutexattr_gettype
|
|
will fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EINVAL
|
|
Invalid value for
|
|
.Fa attr .
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr pthread_mutex_init 3
|
|
.Sh STANDARDS
|
|
.Fn pthread_mutexattr_init
|
|
and
|
|
.Fn pthread_mutexattr_destroy
|
|
conform to
|
|
.St -p1003.1-96
|
|
.Pp
|
|
.Fn pthread_mutexattr_setprioceiling ,
|
|
.Fn pthread_mutexattr_getprioceiling ,
|
|
.Fn pthread_mutexattr_setprotocol ,
|
|
.Fn pthread_mutexattr_getprotocol ,
|
|
.Fn pthread_mutexattr_settype ,
|
|
and
|
|
.Fn pthread_mutexattr_gettype
|
|
conform to
|
|
.St -susv2
|