summaryrefslogtreecommitdiff
path: root/lib/libpthread/pthread_attr_getschedparam.3
diff options
context:
space:
mode:
authorjruoho <jruoho@NetBSD.org>2010-07-08 22:19:26 +0000
committerjruoho <jruoho@NetBSD.org>2010-07-08 22:19:26 +0000
commitec0cdba3c926d6d22bc86695da71fee291472bb8 (patch)
tree5785be2c38eb19bba70df51ded1e6b9197883223 /lib/libpthread/pthread_attr_getschedparam.3
parent7739d1fed5796a48f21653e973549c2666166877 (diff)
Group also pthread_attr_getschedparam(3) and pthread_attr_getschedpolicy(3),
as these two pages fit well together.
Diffstat (limited to 'lib/libpthread/pthread_attr_getschedparam.3')
-rw-r--r--lib/libpthread/pthread_attr_getschedparam.350
1 files changed, 44 insertions, 6 deletions
diff --git a/lib/libpthread/pthread_attr_getschedparam.3 b/lib/libpthread/pthread_attr_getschedparam.3
index d01f19b8245..7269d217ae7 100644
--- a/lib/libpthread/pthread_attr_getschedparam.3
+++ b/lib/libpthread/pthread_attr_getschedparam.3
@@ -1,4 +1,4 @@
-.\" $NetBSD: pthread_attr_getschedparam.3,v 1.1 2010/07/07 16:04:19 jruoho Exp $
+.\" $NetBSD: pthread_attr_getschedparam.3,v 1.2 2010/07/08 22:19:26 jruoho Exp $
.\"
.\" Copyright (c) 2010 Jukka Ruohonen <jruohonen@iki.fi>
.\" All rights reserved.
@@ -30,7 +30,7 @@
.Os
.Sh NAME
.Nm pthread_attr_getschedparam
-.Nd get and set scheduling parameter attribute
+.Nd get and set scheduling attributes
.Sh LIBRARY
.Lb libpthread
.Sh SYNOPSIS
@@ -41,6 +41,11 @@
.Ft int
.Fn pthread_attr_setschedparam \
"pthread_attr_t *attr" "const struct sched_param *param"
+.Ft int
+.Fn pthread_attr_getschedpolicy \
+"const pthread_attr_t * restrict attr" "int * restrict policy"
+.Ft int
+.Fn pthread_attr_setschedpolicy "pthread_attr_t *attr" "int policy"
.Sh DESCRIPTION
The
.Fn pthread_attr_getschedparam
@@ -60,11 +65,27 @@ Refer to
and
.Xr sched 3
for additional details.
+.Pp
+The
+.Fn pthread_attr_getschedpolicy
+and
+.Fn pthread_attr_setschedpolicy
+functions get and set the scheduling policy attribute,
+.Fa policy ,
+in the
+.Fa attr
+object.
+The supported values of
+.Fa policy
+are the same ones listed in
+.Xr pthread_schedparam 3 .
.Sh RETURN VALUES
-If successful, both functions return 0.
+If successful, all described functions return 0.
Otherwise, an error number is returned to indicate the error.
.Sh ERRORS
-Both functions may fail if:
+The
+.Fn pthread_attr_getschedparam
+function may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
An invalid parameter was specified.
@@ -72,15 +93,32 @@ An invalid parameter was specified.
.Pp
The
.Fn pthread_attr_setschedparam
-function may also fail if:
+function may fail if:
.Bl -tag -width Er
+.It Bq Er EINVAL
+An invalid parameter was specified.
.It Bq Er ENOMEM
There was insufficient memory.
.El
+.Pp
+The
+.Fn pthread_attr_setschedpolicy
+function may fail if:
+.Bl -tag -width Er
+.It Bq Er ENOMEM
+There was insufficient memory.
+.It Bq Er ENOTSUP
+An unsupported
+.Fa policy
+was specified.
+.El
+.Pp
+No errors are defined for
+.Fn pthread_attr_getschedpolicy .
.Sh SEE ALSO
.Xr pthread_attr 3 ,
.Xr pthread_schedparam 3 ,
.Xr sched 3
.Sh STANDARDS
-Both functions conform to
+These functions conform to
.St -p1003.1-2008 .