projects / apple / libc.git / blame
| Commit | Line | Data |
|---|---|---|
| 5b2abdfb 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 | .\" | |
| 28 | .\" $FreeBSD: src/lib/libc_r/man/pthread_schedparam.3,v 1.2.2.4 2001/08/17 15:42:52 ru Exp $ | |
| 29 | .Dd May 1, 2000 | |
| 30 | .Dt PTHREAD_SCHEDPARAM 3 | |
| 31 | .Os | |
| 32 | .Sh NAME | |
| 33 | .Nm pthread_setschedparam , | |
| 34 | .Nm pthread_getschedparam | |
| 35 | .Nd thread scheduling parameter manipulation | |
| 36 | .Sh SYNOPSIS | |
| 37 | .Fd #include <pthread.h> | |
| 38 | .Ft int | |
| 39 | .Fn pthread_setschedparam "pthread_t thread" "int policy" "const struct sched_param *param" | |
| 40 | .Ft int | |
| 41 | .Fn pthread_getschedparam "pthread_t thread" "int *policy" "struct sched_param *param" | |
| 42 | .Sh DESCRIPTION | |
| 43 | The | |
| 44 | .Fn pthread_setschedparam | |
| 45 | and | |
| 46 | .Fn pthread_getschedparam | |
| 47 | functions set and get the scheduling parameters of individual threads. | |
| 48 | The scheduling policy for a thread can either be | |
| 49 | .Dv SCHED_FIFO | |
| 50 | (first in, first out) or | |
| 51 | .Dv SCHED_RR | |
| 52 | (round-robin). | |
| 53 | The thread priority (accessed via | |
| 54 | .Va param->sched_priority ) | |
| 55 | must be at least | |
| 56 | .Dv PTHREAD_MIN_PRIORITY | |
| 57 | and no more than | |
| 58 | .Dv PTHREAD_MAX_PRIORITY . | |
| 59 | .Sh RETURN VALUES | |
| 60 | If successful, these functions return 0. | |
| 61 | Otherwise, an error number is returned to indicate the error. | |
| 62 | .Sh ERRORS | |
| 63 | .Fn pthread_setschedparam | |
| 64 | will fail if: | |
| 65 | .Bl -tag -width Er | |
| 66 | .It Bq Er EINVAL | |
| 67 | Invalid value for | |
| 68 | .Va policy . | |
| 69 | .It Bq Er ENOTSUP | |
| 70 | Invalid value for scheduling parameters. | |
| 71 | .It Bq Er ESRCH | |
| 72 | Non-existent thread | |
| 73 | .Va thread . | |
| 74 | .El | |
| 75 | .Pp | |
| 76 | .Fn pthread_getschedparam | |
| 77 | will fail if: | |
| 78 | .Bl -tag -width Er | |
| 79 | .It Bq Er ESRCH | |
| 80 | Non-existent thread | |
| 81 | .Va thread . | |
| 82 | .El | |
| 83 | .Sh STANDARDS | |
| 84 | .Fn pthread_setschedparam | |
| 85 | and | |
| 86 | .Fn pthread_getschedparam | |
| 87 | conform to | |
| 88 | .St -susv2 |