xref: /freebsd-14.2/lib/libc/sys/timer_delete.2 (revision fa9896e0)
15507a2aeSRuslan Ermilov.\" Copyright (c) 2005 David Xu <[email protected]>
2b1e515a3SDavid Xu.\" All rights reserved.
3bb5eebe6SDavid Xu.\"
4bb5eebe6SDavid Xu.\" Redistribution and use in source and binary forms, with or without
5bb5eebe6SDavid Xu.\" modification, are permitted provided that the following conditions
6bb5eebe6SDavid Xu.\" are met:
7bb5eebe6SDavid Xu.\" 1. Redistributions of source code must retain the above copyright
8bb5eebe6SDavid Xu.\"    notice(s), this list of conditions and the following disclaimer as
9bb5eebe6SDavid Xu.\"    the first lines of this file unmodified other than the possible
10bb5eebe6SDavid Xu.\"    addition of one or more copyright notices.
11bb5eebe6SDavid Xu.\" 2. Redistributions in binary form must reproduce the above copyright
12bb5eebe6SDavid Xu.\"    notice(s), this list of conditions and the following disclaimer in
13bb5eebe6SDavid Xu.\"    the documentation and/or other materials provided with the
14bb5eebe6SDavid Xu.\"    distribution.
15bb5eebe6SDavid Xu.\"
16bb5eebe6SDavid Xu.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17bb5eebe6SDavid Xu.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18bb5eebe6SDavid Xu.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19bb5eebe6SDavid Xu.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
20bb5eebe6SDavid Xu.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21bb5eebe6SDavid Xu.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22bb5eebe6SDavid Xu.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23bb5eebe6SDavid Xu.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24bb5eebe6SDavid Xu.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25bb5eebe6SDavid Xu.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26bb5eebe6SDavid Xu.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27bb5eebe6SDavid Xu.\"
285507a2aeSRuslan Ermilov.Dd September 11, 2000
29bb5eebe6SDavid Xu.Dt TIMER_DELETE 2
30bb5eebe6SDavid Xu.Os
31bb5eebe6SDavid Xu.Sh NAME
32bb5eebe6SDavid Xu.Nm timer_delete
335507a2aeSRuslan Ermilov.Nd "delete a per-process timer (REALTIME)"
34bb5eebe6SDavid Xu.Sh LIBRARY
35e9311906SDavid Xu.Lb librt
36bb5eebe6SDavid Xu.Sh SYNOPSIS
37bb5eebe6SDavid Xu.In time.h
38bb5eebe6SDavid Xu.Ft int
39bb5eebe6SDavid Xu.Fn timer_delete "timer_t timerid"
40bb5eebe6SDavid Xu.Sh DESCRIPTION
41bb5eebe6SDavid XuThe
42bb5eebe6SDavid Xu.Fn timer_delete
435507a2aeSRuslan Ermilovsystem call
44bb5eebe6SDavid Xudeletes the specified timer,
45bb5eebe6SDavid Xu.Fa timerid ,
46bb5eebe6SDavid Xupreviously created by the
475507a2aeSRuslan Ermilov.Xr timer_create 2
485507a2aeSRuslan Ermilovsystem call.
495507a2aeSRuslan ErmilovIf the timer is armed when
50bb5eebe6SDavid Xu.Fn timer_delete
51bb5eebe6SDavid Xuis called, the behavior is as if the timer is automatically disarmed before
525507a2aeSRuslan Ermilovremoval.
535507a2aeSRuslan ErmilovPending signals for the deleted timer are cleared.
54bb5eebe6SDavid Xu.Sh RETURN VALUES
555507a2aeSRuslan Ermilov.Rv -std
56bb5eebe6SDavid Xu.Sh ERRORS
57bb5eebe6SDavid XuThe
58bb5eebe6SDavid Xu.Fn timer_delete
595507a2aeSRuslan Ermilovsystem call
60bb5eebe6SDavid Xuwill fail if:
61bb5eebe6SDavid Xu.Bl -tag -width Er
62bb5eebe6SDavid Xu.It Bq Er EINVAL
635507a2aeSRuslan ErmilovThe timer ID specified by
645507a2aeSRuslan Ermilov.Fa timerid
655507a2aeSRuslan Ermilovis not a valid timer ID.
66bb5eebe6SDavid Xu.El
67bb5eebe6SDavid Xu.Sh SEE ALSO
68bb5eebe6SDavid Xu.Xr timer_create 2
69bb5eebe6SDavid Xu.Sh STANDARDS
70bb5eebe6SDavid XuThe
71bb5eebe6SDavid Xu.Fn timer_delete
725507a2aeSRuslan Ermilovsystem call conforms to
73*9f63b422SGlen Barber.St -p1003.1-2004 .
746f59c4c0SDavid Xu.Sh HISTORY
75a73a3ab5SRuslan ErmilovSupport for
76a73a3ab5SRuslan Ermilov.Tn POSIX
77a73a3ab5SRuslan Ermilovper-process timer first appeared in
786f59c4c0SDavid Xu.Fx 7.0 .
79