diff options
Diffstat (limited to 'lib/libpthread/pthread_attr_getschedparam.3')
| -rw-r--r-- | lib/libpthread/pthread_attr_getschedparam.3 | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/lib/libpthread/pthread_attr_getschedparam.3 b/lib/libpthread/pthread_attr_getschedparam.3 new file mode 100644 index 00000000000..d01f19b8245 --- /dev/null +++ b/lib/libpthread/pthread_attr_getschedparam.3 @@ -0,0 +1,86 @@ +.\" $NetBSD: pthread_attr_getschedparam.3,v 1.1 2010/07/07 16:04:19 jruoho Exp $ +.\" +.\" Copyright (c) 2010 Jukka Ruohonen <jruohonen@iki.fi> +.\" 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, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, 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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``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 FOUNDATION OR CONTRIBUTORS +.\" 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. +.\" +.Dd July 7, 2010 +.Dt PTHREAD_ATTR_GETSCHEDPARAM 3 +.Os +.Sh NAME +.Nm pthread_attr_getschedparam +.Nd get and set scheduling parameter attribute +.Sh LIBRARY +.Lb libpthread +.Sh SYNOPSIS +.In pthread.h +.Ft int +.Fn pthread_attr_getschedparam \ +"const pthread_attr_t * restrict attr" "struct sched_param * restrict param" +.Ft int +.Fn pthread_attr_setschedparam \ +"pthread_attr_t *attr" "const struct sched_param *param" +.Sh DESCRIPTION +The +.Fn pthread_attr_getschedparam +and +.Fn pthread_attr_setschedparam +functions obtain and set the scheduling parameter attribute in the +.Fa attr +object. +The +.Vt sched_param +structure is defined in +.In sched.h . +At minimum this structure contains only a single member, +.Vt sched_priority . +Refer to +.Xr pthread_schedparam 3 +and +.Xr sched 3 +for additional details. +.Sh RETURN VALUES +If successful, both functions return 0. +Otherwise, an error number is returned to indicate the error. +.Sh ERRORS +Both functions may fail if: +.Bl -tag -width Er +.It Bq Er EINVAL +An invalid parameter was specified. +.El +.Pp +The +.Fn pthread_attr_setschedparam +function may also fail if: +.Bl -tag -width Er +.It Bq Er ENOMEM +There was insufficient memory. +.El +.Sh SEE ALSO +.Xr pthread_attr 3 , +.Xr pthread_schedparam 3 , +.Xr sched 3 +.Sh STANDARDS +Both functions conform to +.St -p1003.1-2008 . |
