2003-09-14 02:31:04 +04:00
|
|
|
.\" $NetBSD: timer_create.2,v 1.2 2003/09/13 22:31:04 kleink Exp $
|
2003-09-14 02:22:29 +04:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c) 2003 The NetBSD Foundation, Inc.
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
|
|
|
.\" by Christos Zoulas.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
|
|
|
.\" must display the following acknowledgement:
|
|
|
|
|
.\" This product includes software developed by the NetBSD
|
|
|
|
|
.\" Foundation, Inc. and its contributors.
|
|
|
|
|
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
|
|
|
|
.\" contributors may be used to endorse or promote products derived
|
|
|
|
|
.\" from this software without specific prior written permission.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
|
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
|
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
|
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
|
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.Dd September 13, 2003
|
|
|
|
|
.Dt TIMER_CREATE 2
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm timer_create
|
|
|
|
|
.Nd create a per-process timer
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In time.h
|
|
|
|
|
.In signal.h
|
|
|
|
|
.Ft int
|
2003-09-14 02:31:04 +04:00
|
|
|
.Fn timer_create "clockid_t clockid" "struct sigevent * restrict evp" "timer_t * restrict timerid"
|
2003-09-14 02:22:29 +04:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn timer_create
|
|
|
|
|
function creates a per-process timer using the clock specified in the
|
|
|
|
|
.Ar clockid
|
|
|
|
|
argument.
|
|
|
|
|
If it succeeds, the
|
|
|
|
|
.Fn timer_create
|
|
|
|
|
function fills in the
|
|
|
|
|
.Ar timerid
|
|
|
|
|
argument with an id accociated with the timer created that can be used by
|
|
|
|
|
other timer related calls. The
|
|
|
|
|
.Ar clockid
|
|
|
|
|
must be a valid clock id as defined in
|
|
|
|
|
.In time.h .
|
|
|
|
|
The timer is created in a disarmed state.
|
|
|
|
|
.Pp
|
|
|
|
|
An optional (non-
|
|
|
|
|
.Dv NULL
|
|
|
|
|
sigevent argument can be specified by the
|
|
|
|
|
.Ar evp
|
|
|
|
|
argument. If the
|
|
|
|
|
.Ar evp
|
|
|
|
|
argument is
|
|
|
|
|
.Dv NULL ,
|
|
|
|
|
then it defaults to
|
|
|
|
|
.Fa sigev_notify
|
|
|
|
|
set to
|
|
|
|
|
.Dv SIGEV_SIGVAL
|
|
|
|
|
and
|
|
|
|
|
.Fa sigev_value
|
|
|
|
|
set to
|
|
|
|
|
.Ar timerid .
|
|
|
|
|
See
|
|
|
|
|
.Xr siginfo 5
|
|
|
|
|
for accessing those values from a signal handler.
|
|
|
|
|
.Sh NOTES
|
|
|
|
|
Timers are not inherited after a
|
|
|
|
|
.Xr fork 2
|
|
|
|
|
and are disarmed and deleted by an
|
|
|
|
|
.Xr exec 2 .
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
If the
|
|
|
|
|
.Fn timer_create
|
|
|
|
|
call succeed, it returns 0, and fills in the
|
|
|
|
|
.Ar timerid
|
|
|
|
|
argument with the id of the new timer that was created.
|
|
|
|
|
If the call fails, it returns -1, and sets errno to indicate the error.
|
|
|
|
|
.Sh ERRORS
|
|
|
|
|
The
|
|
|
|
|
.Fn timer_create
|
|
|
|
|
function will fail if:
|
|
|
|
|
.Bl -tag -width Er
|
|
|
|
|
.It Bq Er EAGAIN
|
|
|
|
|
The system is out of resources to satisfy this request, or the process has
|
|
|
|
|
created all the timers it is allowed.
|
|
|
|
|
.It Bq Er EINVAL
|
|
|
|
|
The clock id in the
|
|
|
|
|
.Ar clockid
|
|
|
|
|
is invalid.
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr clock_gettime 2 ,
|
|
|
|
|
.Xr clock_settime 2 ,
|
|
|
|
|
.Xr clock_getres 2 ,
|
|
|
|
|
.Xr timer_delete 2 ,
|
|
|
|
|
.Xr timer_gettime 2 ,
|
|
|
|
|
.Xr timer_getoverrun 2 ,
|
|
|
|
|
.Xr timer_settime 2
|
|
|
|
|
.Sh STANDARDS
|
|
|
|
|
.St -p1003.1b-93 ,
|
|
|
|
|
.St -p1003.1i-95
|
