1 .\" $NetBSD: timer_create.2,v 1.12 2012/11/06 21:16:21 uwe Exp $
3 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Christos Zoulas.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
35 .Nd create a per-process timer
42 .Fn timer_create "clockid_t clockid" "struct sigevent * restrict evp" "timer_t * restrict timerid"
46 function creates a per-process timer using the clock specified in the
53 argument with an id associated with the timer created that can be used by
54 other timer related calls.
57 must be a valid clock id as defined in
59 The timer is created in a disarmed state.
64 argument can be specified by the
72 .Fa evp-\*[Gt]sigev_notify
76 .Fa evp-\*[Gt]sigev_value
83 Timers are not inherited after a
85 and are disarmed and deleted by an
90 function returns 0, and fills in the
92 argument with the id of the new timer that was created.
93 Otherwise, it returns \-1, and sets
95 to indicate the error.
99 function will fail if:
102 The system is out of resources to satisfy this request, or the process has
103 created all the timers it is allowed.
107 is not a valid clock id.
111 .Xr clock_gettime 2 ,
112 .Xr clock_settime 2 ,
114 .Xr timer_getoverrun 2 ,
115 .Xr timer_gettime 2 ,
116 .Xr timer_settime 2 ,