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

.\" Copyright (c) 2004-2007 Apple Inc. All rights reserved.
.Dd December 31, 2007
.Dt PTHREAD_ATTR 3
.Os
.Sh NAME
.Nm pthread_attr_getscope ,
.Nm pthread_attr_setscope 
.Nd thread attribute operations
.Sh SYNOPSIS
.Fd #include <pthread.h>
.Ft int
.Fo pthread_attr_getscope
.Fa "const pthread_attr_t *restrict attr"
.Fa "int *restrict contentionscope"
.Fc
.Ft int
.Fo pthread_attr_setscope
.Fa "pthread_attr_t *attr"
.Fa "int contentionscope"
.Fc
.Sh DESCRIPTION
Thread attributes are used to specify parameters to
.Fn pthread_create .
One attribute object can be used in multiple calls to
.Fn pthread_create ,
with or without modifications between calls.
.Pp
The 
.Fn pthread_attr_setscope
and 
.Fn pthread_attr_getscope
functions, respectively, set and get the attribute within
.Fa attr
argument that controls the contention scope of the thread.
The acceptable values are PTHREAD_SCOPE_SYSTEM, indicating a scheduling contention scope that
is system-wide, and PTHREAD_SCOPE_PROCESS, which indicates a process scheduling contention scope.
Currently on Mac OS X we only support PTHREAD_SCOPE_SYSTEM.
.Sh RETURN VALUES
If successful, these functions return 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
.Pp
.Fn pthread_attr_getscope
will fail if:
.Bl -tag -width Er
.\" ========
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.\" ========
.El
.Pp
.Fn pthread_attr_setscope
will fail if:
.Bl -tag -width Er
.\" ========
.It Bq Er EINVAL
Invalid value for
.Fa attr .
.\" ========
.It Bq Er ENOTSUP
Invalid or unsupported value for
.Fa contentionscope .
.El
.Sh SEE ALSO
.Xr pthread_create 3 ,
.Xr pthread_attr_init 3 ,
.Xr pthread_attr_setinheritsched 3 ,
.Xr pthread_attr_setschedpolicy 3 ,
.Xr pthread_attr_setschedparam 3 
.Sh STANDARDS
.Fn pthread_attr_setscope ,
.Fn pthread_attr_getscope
conform to
.St -susv2
Commit	Line	Data
f1a1da6c A	1	.\" Copyright (c) 2004-2007 Apple Inc. All rights reserved.
	2	.Dd December 31, 2007
	3	.Dt PTHREAD_ATTR 3
	4	.Os
	5	.Sh NAME
	6	.Nm pthread_attr_getscope ,
	7	.Nm pthread_attr_setscope
	8	.Nd thread attribute operations
	9	.Sh SYNOPSIS
	10	.Fd #include <pthread.h>
	11	.Ft int
	12	.Fo pthread_attr_getscope
	13	.Fa "const pthread_attr_t *restrict attr"
	14	.Fa "int *restrict contentionscope"
	15	.Fc
	16	.Ft int
	17	.Fo pthread_attr_setscope
	18	.Fa "pthread_attr_t *attr"
	19	.Fa "int contentionscope"
	20	.Fc
	21	.Sh DESCRIPTION
	22	Thread attributes are used to specify parameters to
	23	.Fn pthread_create .
	24	One attribute object can be used in multiple calls to
	25	.Fn pthread_create ,
	26	with or without modifications between calls.
	27	.Pp
	28	The
	29	.Fn pthread_attr_setscope
	30	and
	31	.Fn pthread_attr_getscope
	32	functions, respectively, set and get the attribute within
	33	.Fa attr
	34	argument that controls the contention scope of the thread.
	35	The acceptable values are PTHREAD_SCOPE_SYSTEM, indicating a scheduling contention scope that
	36	is system-wide, and PTHREAD_SCOPE_PROCESS, which indicates a process scheduling contention scope.
	37	Currently on Mac OS X we only support PTHREAD_SCOPE_SYSTEM.
	38	.Sh RETURN VALUES
	39	If successful, these functions return 0.
	40	Otherwise, an error number is returned to indicate the error.
	41	.Sh ERRORS
	42	.Pp
	43	.Fn pthread_attr_getscope
	44	will fail if:
	45	.Bl -tag -width Er
	46	.\" ========
	47	.It Bq Er EINVAL
	48	Invalid value for
	49	.Fa attr .
	50	.\" ========
	51	.El
	52	.Pp
	53	.Fn pthread_attr_setscope
	54	will fail if:
	55	.Bl -tag -width Er
	56	.\" ========
	57	.It Bq Er EINVAL
	58	Invalid value for
	59	.Fa attr .
	60	.\" ========
	61	.It Bq Er ENOTSUP
	62	Invalid or unsupported value for
	63	.Fa contentionscope .
	64	.El
65	.Sh SEE ALSO
66	.Xr pthread_create 3 ,
67	.Xr pthread_attr_init 3 ,
68	.Xr pthread_attr_setinheritsched 3 ,
69	.Xr pthread_attr_setschedpolicy 3 ,
70	.Xr pthread_attr_setschedparam 3
71	.Sh STANDARDS
72	.Fn pthread_attr_setscope ,
73	.Fn pthread_attr_getscope
74	conform to
75	.St -susv2