xref: /freebsd/lib/libsys/timer_delete.2 (revision 8269e7673cf033aba67dab8264fe719920c70f87)
1*8269e767SBrooks Davis.\" Copyright (c) 2005 David Xu <davidxu@FreeBSD.org>
2*8269e767SBrooks Davis.\" All rights reserved.
3*8269e767SBrooks Davis.\"
4*8269e767SBrooks Davis.\" Redistribution and use in source and binary forms, with or without
5*8269e767SBrooks Davis.\" modification, are permitted provided that the following conditions
6*8269e767SBrooks Davis.\" are met:
7*8269e767SBrooks Davis.\" 1. Redistributions of source code must retain the above copyright
8*8269e767SBrooks Davis.\"    notice(s), this list of conditions and the following disclaimer as
9*8269e767SBrooks Davis.\"    the first lines of this file unmodified other than the possible
10*8269e767SBrooks Davis.\"    addition of one or more copyright notices.
11*8269e767SBrooks Davis.\" 2. Redistributions in binary form must reproduce the above copyright
12*8269e767SBrooks Davis.\"    notice(s), this list of conditions and the following disclaimer in
13*8269e767SBrooks Davis.\"    the documentation and/or other materials provided with the
14*8269e767SBrooks Davis.\"    distribution.
15*8269e767SBrooks Davis.\"
16*8269e767SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17*8269e767SBrooks Davis.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*8269e767SBrooks Davis.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19*8269e767SBrooks Davis.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
20*8269e767SBrooks Davis.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21*8269e767SBrooks Davis.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22*8269e767SBrooks Davis.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23*8269e767SBrooks Davis.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24*8269e767SBrooks Davis.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25*8269e767SBrooks Davis.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26*8269e767SBrooks Davis.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27*8269e767SBrooks Davis.\"
28*8269e767SBrooks Davis.Dd September 11, 2000
29*8269e767SBrooks Davis.Dt TIMER_DELETE 2
30*8269e767SBrooks Davis.Os
31*8269e767SBrooks Davis.Sh NAME
32*8269e767SBrooks Davis.Nm timer_delete
33*8269e767SBrooks Davis.Nd "delete a per-process timer (REALTIME)"
34*8269e767SBrooks Davis.Sh LIBRARY
35*8269e767SBrooks Davis.Lb librt
36*8269e767SBrooks Davis.Sh SYNOPSIS
37*8269e767SBrooks Davis.In time.h
38*8269e767SBrooks Davis.Ft int
39*8269e767SBrooks Davis.Fn timer_delete "timer_t timerid"
40*8269e767SBrooks Davis.Sh DESCRIPTION
41*8269e767SBrooks DavisThe
42*8269e767SBrooks Davis.Fn timer_delete
43*8269e767SBrooks Davissystem call
44*8269e767SBrooks Davisdeletes the specified timer,
45*8269e767SBrooks Davis.Fa timerid ,
46*8269e767SBrooks Davispreviously created by the
47*8269e767SBrooks Davis.Xr timer_create 2
48*8269e767SBrooks Davissystem call.
49*8269e767SBrooks DavisIf the timer is armed when
50*8269e767SBrooks Davis.Fn timer_delete
51*8269e767SBrooks Davisis called, the behavior is as if the timer is automatically disarmed before
52*8269e767SBrooks Davisremoval.
53*8269e767SBrooks DavisPending signals for the deleted timer are cleared.
54*8269e767SBrooks Davis.Sh RETURN VALUES
55*8269e767SBrooks Davis.Rv -std
56*8269e767SBrooks Davis.Sh ERRORS
57*8269e767SBrooks DavisThe
58*8269e767SBrooks Davis.Fn timer_delete
59*8269e767SBrooks Davissystem call
60*8269e767SBrooks Daviswill fail if:
61*8269e767SBrooks Davis.Bl -tag -width Er
62*8269e767SBrooks Davis.It Bq Er EINVAL
63*8269e767SBrooks DavisThe timer ID specified by
64*8269e767SBrooks Davis.Fa timerid
65*8269e767SBrooks Davisis not a valid timer ID.
66*8269e767SBrooks Davis.El
67*8269e767SBrooks Davis.Sh SEE ALSO
68*8269e767SBrooks Davis.Xr timer_create 2
69*8269e767SBrooks Davis.Sh STANDARDS
70*8269e767SBrooks DavisThe
71*8269e767SBrooks Davis.Fn timer_delete
72*8269e767SBrooks Davissystem call conforms to
73*8269e767SBrooks Davis.St -p1003.1-2004 .
74*8269e767SBrooks Davis.Sh HISTORY
75*8269e767SBrooks DavisSupport for
76*8269e767SBrooks Davis.Tn POSIX
77*8269e767SBrooks Davisper-process timer first appeared in
78*8269e767SBrooks Davis.Fx 7.0 .
79