[apple/libpthread.git] / man / pthread_condattr.3

.\" 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 9, 2010
.Dt PTHREAD_CONDATTR 3
.Os
.Sh NAME
.Nm pthread_condattr_init ,
.Nm pthread_condattr_destroy ,
.Nd condition attribute operations
.Sh SYNOPSIS
.In pthread.h
.Ft int
.Fn pthread_condattr_init "pthread_condattr_t *attr"
.Ft int
.Fn pthread_condattr_destroy "pthread_condattr_t *attr"
.Sh DESCRIPTION
Condition attribute objects are used to specify parameters to
.Fn pthread_cond_init .
.Fx Ns 's
implementation of conditions does not support any non-default
attributes, so these functions are not very useful, though they are required to
to be present by
.Tn POSIX .
.Pp
The
.Fn pthread_condattr_init
function initializes a condition attribute object with the default attributes.
.Pp
The
.Fn pthread_condattr_destroy
function destroys a condition attribute object.
.Sh RETURN VALUES
If successful, these functions return 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
.Fn pthread_condattr_destroy
will fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.El
.Pp
.Fn pthread_condattr_init
will fail if:
.Bl -tag -width Er
.It Bq Er ENOMEM
Out of memory.
.El
.Sh SEE ALSO
.Xr pthread_cond_init 3
.Sh STANDARDS
The
.Fn pthread_condattr_init
and
.Fn pthread_condattr_destroy
functions conform to
.St -p1003.1-96
Commit	Line	Data
f1a1da6c A	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	.\"
2546420a A	28	.\" $FreeBSD$
2546420a A	29	.Dd May 9, 2010
f1a1da6c A	30	.Dt PTHREAD_CONDATTR 3
	31	.Os
	32	.Sh NAME
2546420a	33	.Nm pthread_condattr_init ,
f1a1da6c	34	.Nm pthread_condattr_destroy ,
f1a1da6c A	35	.Nd condition attribute operations
	36	.Sh SYNOPSIS
	37	.In pthread.h
	38	.Ft int
2546420a	39	.Fn pthread_condattr_init "pthread_condattr_t *attr"
f1a1da6c	40	.Ft int
2546420a	41	.Fn pthread_condattr_destroy "pthread_condattr_t *attr"
f1a1da6c A	42	.Sh DESCRIPTION
	43	Condition attribute objects are used to specify parameters to
	44	.Fn pthread_cond_init .
	45	.Fx Ns 's
	46	implementation of conditions does not support any non-default
	47	attributes, so these functions are not very useful, though they are required to
	48	to be present by
	49	.Tn POSIX .
	50	.Pp
	51	The
	52	.Fn pthread_condattr_init
	53	function initializes a condition attribute object with the default attributes.
	54	.Pp
	55	The
	56	.Fn pthread_condattr_destroy
	57	function destroys a condition attribute object.
	58	.Sh RETURN VALUES
	59	If successful, these functions return 0.
	60	Otherwise, an error number is returned to indicate the error.
	61	.Sh ERRORS
	62	.Fn pthread_condattr_destroy
	63	will fail if:
	64	.Bl -tag -width Er
	65	.It Bq Er EINVAL
	66	Invalid value for
	67	.Fa attr .
	68	.El
	69	.Pp
	70	.Fn pthread_condattr_init
	71	will fail if:
	72	.Bl -tag -width Er
	73	.It Bq Er ENOMEM
	74	Out of memory.
	75	.El
	76	.Sh SEE ALSO
	77	.Xr pthread_cond_init 3
	78	.Sh STANDARDS
2546420a	79	The
f1a1da6c A	80	.Fn pthread_condattr_init
	81	and
	82	.Fn pthread_condattr_destroy
2546420a	83	functions conform to
f1a1da6c	84	.St -p1003.1-96