1.\" $NetBSD: timer_create.2,v 1.7 2004/03/14 10:36:09 snj Exp $ 2.\" 3.\" Copyright (c) 2003 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Christos Zoulas. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 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. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd September 13, 2003 38.Dt TIMER_CREATE 2 39.Os 40.Sh NAME 41.Nm timer_create 42.Nd create a per-process timer 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.In time.h 47.In signal.h 48.Ft int 49.Fn timer_create "clockid_t clockid" "struct sigevent * restrict evp" "timer_t * restrict timerid" 50.Sh DESCRIPTION 51The 52.Fn timer_create 53function creates a per-process timer using the clock specified in the 54.Ar clockid 55argument. 56If it succeeds, the 57.Fn timer_create 58function fills in the 59.Ar timerid 60argument with an id associated with the timer created that can be used by 61other timer related calls. 62The 63.Ar clockid 64must be a valid clock id as defined in 65.Aq Pa time.h . 66The timer is created in a disarmed state. 67.Pp 68An optional 69.Pq non- Ns Dv NULL 70sigevent argument can be specified by the 71.Ar evp 72argument. 73If the 74.Ar evp 75argument is 76.Dv NULL , 77then it defaults to 78.Fa sigev_notify 79set to 80.Dv SIGEV_SIGVAL 81and 82.Fa sigev_value 83set to 84.Ar timerid . 85See 86.Xr siginfo 2 87for accessing those values from a signal handler. 88.Sh NOTES 89Timers are not inherited after a 90.Xr fork 2 91and are disarmed and deleted by an 92.Xr exec 3 . 93.Sh RETURN VALUES 94If successful, the 95.Fn timer_create 96function returns 0, and fills in the 97.Ar timerid 98argument with the id of the new timer that was created. 99Otherwise, it returns \-1, and sets 100.Dv errno 101to indicate the error. 102.Sh ERRORS 103The 104.Fn timer_create 105function will fail if: 106.Bl -tag -width Er 107.It Bq Er EAGAIN 108The system is out of resources to satisfy this request, or the process has 109created all the timers it is allowed. 110.It Bq Er EINVAL 111The argument 112.Ar clockid 113is not a valid clock id. 114.El 115.Sh SEE ALSO 116.Xr clock_getres 2 , 117.Xr clock_gettime 2 , 118.Xr clock_settime 2 , 119.Xr timer_delete 2 , 120.Xr timer_getoverrun 2 , 121.Xr timer_gettime 2 , 122.Xr timer_settime 2 123.Sh STANDARDS 124.St -p1003.1b-93 , 125.St -p1003.1i-95 126