usr/src/man/man3c/timer_create.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH TIMER_CREATE 3C "Sep 15, 2015"
  13 .SH NAME
  14 timer_create \- create a timer
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <signal.h>
  19 #include <time.h>
  20
  21 \fBint\fR \fBtimer_create\fR(\fBclockid_t\fR \fIclock_id\fR,
  22      \fBstruct sigevent *restrict\fR \fIevp\fR, \fBtimer_t *restrict\fR \fItimerid\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .LP
  27 The \fBtimer_create()\fR function creates a timer using the specified clock,
  28 \fIclock_id\fR, as the timing base. The \fBtimer_create()\fR function returns,
  29 in the location referenced by \fItimerid\fR, a timer \fBID\fR of type
  30 \fBtimer_t\fR used to identify the timer in timer requests. This timer \fBID\fR
  31 will be unique within the calling process until the timer is deleted. The
  32 particular clock, \fIclock_id\fR, is defined in <\fBtime.h\fR>. The timer whose
  33 \fBID\fR is returned will be in a disarmed state upon return from
  34 \fBtimer_create()\fR, and can be started using \fBtimer_settime\fR(3C).
  35 .LP
  36 The \fIevp\fR argument, if non-null, points to a \fBsigevent\fR structure. This
  37 structure, allocated by the application, defines the asynchronous notification
  38 that will occur when the timer expires (see \fBsignal.h\fR(3HEAD) for event
  39 notification details). If the \fIevp\fR argument is \fINULL\fR, the effect is
  40 as if the \fIevp\fR argument pointed to a \fBsigevent\fR structure with the
  41 \fBsigev_notify\fR member having the value \fBSIGEV_SIGNAL\fR, the
  42 \fBsigev_signo\fR having the value \fBSIGALRM\fR, and the \fBsigev_value\fR
  43 member having the value of the timer \fBID\fR.
  44 .LP
  45 The system defines a set of clocks that can be used as timing bases for
  46 per-process timers. The following values for \fIclock_id\fR are supported:
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBCLOCK_REALTIME\fR\fR
  51 .ad
  52 .RS 18n
  53 wall clock
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBCLOCK_VIRTUAL\fR\fR
  60 .ad
  61 .RS 18n
  62 user CPU usage clock
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBCLOCK_PROF\fR\fR
  69 .ad
  70 .RS 18n
  71 user and system CPU usage clock
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBCLOCK_HIGHRES\fR\fR
  78 .ad
  79 .RS 18n
  80 non-adjustable, high-resolution clock
  81 .RE
  82
  83 .sp
  84 .LP
  85 For timers created with a \fIclock_id\fR of \fBCLOCK_HIGHRES\fR, the system
  86 will attempt to use an optimal hardware source. This may include, but is not
  87 limited to, per-CPU timer sources.  The actual hardware source used is
  88 transparent to the user and may change over the lifetime of the timer. For
  89 example, if the caller that created the timer were to change its processor
  90 binding or its processor set, the system may elect to drive the timer with a
  91 hardware source  that better reflects the new binding. Timers based on a
  92 \fIclock_id\fR of \fBCLOCK_HIGHRES\fR are ideally suited for interval timers
  93 that have minimal jitter tolerance.
  94 .LP
  95 Timers are not inherited by a child process across a \fBfork\fR(2) and are
  96 disarmed and deleted by a call to one of the \fBexec\fR functions (see
  97 \fBexec\fR(2)).
  98 .SH RETURN VALUES
  99 .LP
 100 Upon successful completion, \fBtimer_create()\fR returns \fB0\fR and updates
 101 the location referenced by \fItimerid\fR to a \fBtimer_t\fR, which can be
 102 passed to the per-process timer calls. If an error occurs, the function returns
 103 \fB\(mi1\fR and sets \fBerrno\fR to indicate the error. The value of
 104 \fItimerid\fR is undefined if an error occurs.
 105 .SH ERRORS
 106 .LP
 107 The \fBtimer_create()\fR function will fail if:
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBEAGAIN\fR\fR
 112 .ad
 113 .RS 10n
 114 The system lacks sufficient signal queuing resources to honor the request, or
 115 the calling process has already created all of the timers it is allowed by the
 116 system.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBEINVAL\fR\fR
 123 .ad
 124 .RS 10n
 125 The specified clock \fBID\fR, \fIclock_id\fR, is not defined.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBEPERM\fR\fR
 132 .ad
 133 .RS 10n
 134 The specified clock \fBID\fR, \fIclock_id\fR, is \fBCLOCK_HIGHRES\fR and the
 135 {\fBPRIV_PROC_CLOCK_HIGHRES\fR} is not asserted in the effective set of the
 136 calling process.
 137 .RE
 138
 139 .SH ATTRIBUTES
 140 .LP
 141 See \fBattributes\fR(5) for descriptions of the following attributes:
 142 .sp
 143
 144 .sp
 145 .TS
 146 box;
 147 l | l
 148 l | l .
 149 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 150 _
 151 Interface Stability     Committed
 152 _
 153 MT-Level        MT-Safe with exceptions
 154 _
 155 Standard        See \fBstandards\fR(5).
 156 .TE
 157
 158 .SH SEE ALSO
 159 .LP
 160 \fBexec\fR(2), \fBfork\fR(2), \fBtime\fR(2), \fBclock_settime\fR(3C),
 161 \fBsignal\fR(3C), \fBsignal.h\fR(3HEAD), \fBtimer_delete\fR(3C),
 162 \fBtimer_settime\fR(3C), \fBattributes\fR(5), \fBprivileges\fR(5),
 163 \fBstandards\fR(5)