1.\" $NetBSD: pthread_schedparam.3,v 1.5 2008/05/04 19:43:05 martin Exp $ 2.\" 3.\" Copyright (c) 2002 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 14.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 15.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 16.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 17.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 18.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 19.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 20.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 21.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 22.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 23.\" POSSIBILITY OF SUCH DAMAGE. 24.\" 25.\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>. 26.\" All rights reserved. 27.\" 28.\" Redistribution and use in source and binary forms, with or without 29.\" modification, are permitted provided that the following conditions 30.\" are met: 31.\" 1. Redistributions of source code must retain the above copyright 32.\" notice(s), this list of conditions and the following disclaimer as 33.\" the first lines of this file unmodified other than the possible 34.\" addition of one or more copyright notices. 35.\" 2. Redistributions in binary form must reproduce the above copyright 36.\" notice(s), this list of conditions and the following disclaimer in 37.\" the documentation and/or other materials provided with the 38.\" distribution. 39.\" 40.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 41.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 43.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE 44.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 45.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 46.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 47.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 48.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 49.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 50.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51.\" 52.\" $FreeBSD: src/lib/libpthread/man/pthread_schedparam.3,v 1.7 2002/09/16 19:29:29 mini Exp $ 53.Dd January 30, 2003 54.Dt PTHREAD_SCHEDPARAM 3 55.Os 56.Sh NAME 57.Nm pthread_setschedparam , 58.Nm pthread_getschedparam 59.Nd thread scheduling parameter manipulation 60.Sh LIBRARY 61.Lb libpthread 62.Sh SYNOPSIS 63.In pthread.h 64.Ft int 65.Fn pthread_setschedparam "pthread_t thread" "int policy" "const struct sched_param *param" 66.Ft int 67.Fn pthread_getschedparam "pthread_t thread" "int * restrict policy" "struct sched_param * restrict param" 68.Sh DESCRIPTION 69The 70.Fn pthread_setschedparam 71and 72.Fn pthread_getschedparam 73functions set and get the scheduling parameters of individual threads. 74The scheduling policy for a thread can either be 75.Dv SCHED_FIFO 76(first in, first out), 77.Dv SCHED_RR 78(round-robin), 79or 80.Dv SCHED_OTHER 81(system default). 82The thread priority (accessed via 83.Va param-\*[Gt]sched_priority ) 84must be at least 85.Dv PTHREAD_MIN_PRIORITY 86and no more than 87.Dv PTHREAD_MAX_PRIORITY . 88.Sh RETURN VALUES 89If successful, these functions return 0. 90Otherwise, an error number is returned to indicate the error. 91.Sh ERRORS 92.Fn pthread_setschedparam 93may fail if: 94.Bl -tag -width Er 95.It Bq Er EINVAL 96The value specified by 97.Va policy 98is invalid. 99.It Bq Er ENOTSUP 100Invalid value for scheduling parameters. 101.It Bq Er ESRCH 102Non-existent thread 103.Va thread . 104.El 105.Pp 106.Fn pthread_getschedparam 107may fail if: 108.Bl -tag -width Er 109.It Bq Er ESRCH 110Non-existent thread 111.Va thread . 112.El 113.Sh STANDARDS 114.Fn pthread_setschedparam 115and 116.Fn pthread_getschedparam 117conform to 118.St -p1003.1-96 . 119