1.\" $NetBSD: timer_create.2,v 1.12 2012/11/06 21:16:21 uwe 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.\" 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. 29.\" 30.Dd May 19, 2010 31.Dt TIMER_CREATE 2 32.Os 33.Sh NAME 34.Nm timer_create 35.Nd create a per-process timer 36.Sh LIBRARY 37.Lb libc 38.Sh SYNOPSIS 39.In time.h 40.In signal.h 41.Ft int 42.Fn timer_create "clockid_t clockid" "struct sigevent * restrict evp" "timer_t * restrict timerid" 43.Sh DESCRIPTION 44The 45.Fn timer_create 46function creates a per-process timer using the clock specified in the 47.Ar clockid 48argument. 49If it succeeds, the 50.Fn timer_create 51function fills in the 52.Ar timerid 53argument with an id associated with the timer created that can be used by 54other timer related calls. 55The 56.Ar clockid 57must be a valid clock id as defined in 58.In time.h . 59The timer is created in a disarmed state. 60.Pp 61An optional 62.Pq non- Ns Dv NULL 63.Em struct sigevent 64argument can be specified by the 65.Ar evp 66argument. 67If the 68.Ar evp 69argument is 70.Dv NULL , 71then 72.Fa evp-\*[Gt]sigev_notify 73defaults to 74.Dv SIGEV_SIGNAL 75and 76.Fa evp-\*[Gt]sigev_value 77is set to 78.Ar timerid . 79Refer to 80.Xr sigevent 3 81for more details. 82.Sh NOTES 83Timers are not inherited after a 84.Xr fork 2 85and are disarmed and deleted by an 86.Xr exec 3 . 87.Sh RETURN VALUES 88If successful, the 89.Fn timer_create 90function returns 0, and fills in the 91.Ar timerid 92argument with the id of the new timer that was created. 93Otherwise, it returns \-1, and sets 94.Dv errno 95to indicate the error. 96.Sh ERRORS 97The 98.Fn timer_create 99function will fail if: 100.Bl -tag -width Er 101.It Bq Er EAGAIN 102The system is out of resources to satisfy this request, or the process has 103created all the timers it is allowed. 104.It Bq Er EINVAL 105The argument 106.Ar clockid 107is not a valid clock id. 108.El 109.Sh SEE ALSO 110.Xr clock_getres 2 , 111.Xr clock_gettime 2 , 112.Xr clock_settime 2 , 113.Xr timer_delete 2 , 114.Xr timer_getoverrun 2 , 115.Xr timer_gettime 2 , 116.Xr timer_settime 2 , 117.Xr sigevent 3 118.Sh STANDARDS 119.St -p1003.1b-93 , 120.St -p1003.1i-95 121