lib/libc/sys/timer_create.2

   1 .\" Copyright (c) 2005 David Xu <davidxu@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$
  29 .\"
  30 .Dd September 11, 2000
  31 .Dt TIMER_CREATE 2
  32 .Os
  33 .Sh NAME
  34 .Nm timer_create
  35 .Nd "create a per-process timer (REALTIME)"
  36 .Sh LIBRARY
  37 .Lb librt
  38 .Sh SYNOPSIS
  39 .In time.h
  40 .Ft int
  41 .Fo timer_create
  42 .Fa "clockid_t clockid" "struct sigevent *restrict evp"
  43 .Fa "timer_t *restrict timerid"
  44 .Fc
  45 .Sh DESCRIPTION
  46 The
  47 .Fn timer_create
  48 system call creates a per-process timer using the specified clock,
  49 .Fa clock_id ,
  50 as the timing base.
  51 The
  52 .Fn timer_create
  53 system call returns, in the location referenced by
  54 .Fa timerid ,
  55 a timer ID of type
  56 .Vt timer_t
  57 used to identify the timer in timer requests.
  58 This timer ID is unique within the calling process until the timer is deleted.
  59 The particular clock,
  60 .Fa clock_id ,
  61 is defined in
  62 .In time.h .
  63 The timer whose ID is returned is in a disarmed state upon return from
  64 .Fn timer_create .
  65 .Pp
  66 The
  67 .Fa evp
  68 argument, if
  69 .Pf non- Dv NULL ,
  70 points to a
  71 .Vt sigevent
  72 structure.
  73 This structure,
  74 allocated by the application, defines the asynchronous notification to occur
  75 when the timer expires.
  76 If the
  77 .Fa evp
  78 argument is
  79 .Dv NULL ,
  80 the effect is as if the
  81 .Fa evp
  82 argument pointed to a
  83 .Vt sigevent
  84 structure with the
  85 .Va sigev_notify
  86 member having the value
  87 .Dv SIGEV_SIGNAL ,
  88 the
  89 .Va sigev_signo
  90 having a default signal number, and the
  91 .Va sigev_value
  92 member having
  93 the value of the timer ID.
  94 .Pp
  95 The implementations supports a
  96 .Fa clock_id
  97 of
  98 .Dv CLOCK_REALTIME
  99 or
 100 .Dv CLOCK_MONOTONIC .
 101 .Pp
 102 If
 103 .Fa evp->sigev_sigev_notify
 104 is
 105 .Dv SIGEV_THREAD
 106 and
 107 .Fa sev->sigev_notify_attributes
 108 is not
 109 .Dv NULL ,
 110 if the attribute pointed to by
 111 .Fa sev->sigev_notify_attributes
 112 has
 113 a thread stack address specified by a call to
 114 .Fn pthread_attr_setstack
 115 or
 116 .Fn pthread_attr_setstackaddr ,
 117 the results are unspecified if the signal is generated more than once.
 118 .Sh RETURN VALUES
 119 If the call succeeds,
 120 .Fn timer_create
 121 returns zero and updates the location referenced by
 122 .Fa timerid
 123 to a
 124 .Vt timer_t ,
 125 which can be passed to the per-process timer calls.
 126 If an error
 127 occurs, the system call returns a value of \-1
 128 and the global variable
 129 .Va errno
 130 is set to indicate the
 131 error.
 132 The value of
 133 .Fa timerid
 134 is undefined if an error occurs.
 135 .Sh ERRORS
 136 The
 137 .Fn timer_create
 138 system call
 139 will fail if:
 140 .Bl -tag -width Er
 141 .It Bq Er EAGAIN
 142 The calling process has already created all of the timers it is allowed by
 143 this implementation.
 144 .It Bq Er EINVAL
 145 The specified clock ID is not supported.
 146 .It Bq Er EFAULT
 147 Any arguments point outside the allocated address space or there is a
 148 memory protection fault.
 149 .El
 150 .Sh SEE ALSO
 151 .Xr clock_getres 2 ,
 152 .Xr timer_delete 2 ,
 153 .Xr timer_getoverun 2 ,
 154 .Xr siginfo 3
 155 .Sh STANDARDS
 156 The
 157 .Fn timer_create
 158 system call conforms to
 159 .St -p1003.1-2004
 160 .Sh HISTORY
 161 Support for
 162 .Tn POSIX
 163 per-process timer first appeared in
 164 .Fx 7.0 .