lib/libc_r/man/pthread_schedparam.3

   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.5 2001/12/17 10:08:26 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 LIBRARY
  37 .Lb libc_r
  38 .Sh SYNOPSIS
  39 .In pthread.h
  40 .Ft int
  41 .Fn pthread_setschedparam "pthread_t thread" "int policy" "const struct sched_param *param"
  42 .Ft int
  43 .Fn pthread_getschedparam "pthread_t thread" "int *policy" "struct sched_param *param"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn pthread_setschedparam
  47 and
  48 .Fn pthread_getschedparam
  49 functions set and get the scheduling parameters of individual threads.
  50 The scheduling policy for a thread can either be
  51 .Dv SCHED_FIFO
  52 (first in, first out) or
  53 .Dv SCHED_RR
  54 (round-robin).
  55 The thread priority (accessed via
  56 .Va param->sched_priority )
  57 must be at least
  58 .Dv PTHREAD_MIN_PRIORITY
  59 and no more than
  60 .Dv PTHREAD_MAX_PRIORITY .
  61 .Sh RETURN VALUES
  62 If successful, these functions return 0.
  63 Otherwise, an error number is returned to indicate the error.
  64 .Sh ERRORS
  65 .Fn pthread_setschedparam
  66 will fail if:
  67 .Bl -tag -width Er
  68 .It Bq Er EINVAL
  69 Invalid value for
  70 .Va policy .
  71 .It Bq Er ENOTSUP
  72 Invalid value for scheduling parameters.
  73 .It Bq Er ESRCH
  74 Non-existent thread
  75 .Va thread .
  76 .El
  77 .Pp
  78 .Fn pthread_getschedparam
  79 will fail if:
  80 .Bl -tag -width Er
  81 .It Bq Er ESRCH
  82 Non-existent thread
  83 .Va thread .
  84 .El
  85 .Sh STANDARDS
  86 .Fn pthread_setschedparam
  87 and
  88 .Fn pthread_getschedparam
  89 conform to
  90 .St -susv2