2005-11-18 11:53:23 +00:00
|
|
|
.\" Copyright (c) 2005 David Xu <davidxu@FreeBSD.org>
|
2005-11-12 01:19:05 +00:00
|
|
|
.\" All rights reserved.
|
2005-11-11 07:48:38 +00:00
|
|
|
.\"
|
|
|
|
|
.\" 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(s), this list of conditions and the following disclaimer as
|
|
|
|
|
.\" the first lines of this file unmodified other than the possible
|
|
|
|
|
.\" addition of one or more copyright notices.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice(s), this list of conditions and the following disclaimer in
|
|
|
|
|
.\" the documentation and/or other materials provided with the
|
|
|
|
|
.\" distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``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 COPYRIGHT HOLDER(S) 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.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
2005-11-18 11:53:23 +00:00
|
|
|
.Dd September 11, 2000
|
2005-11-11 07:48:38 +00:00
|
|
|
.Dt TIMER_DELETE 2
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm timer_delete
|
2005-11-18 11:53:23 +00:00
|
|
|
.Nd "delete a per-process timer (REALTIME)"
|
2005-11-11 07:48:38 +00:00
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In time.h
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn timer_delete "timer_t timerid"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn timer_delete
|
2005-11-18 11:53:23 +00:00
|
|
|
system call
|
2005-11-11 07:48:38 +00:00
|
|
|
deletes the specified timer,
|
|
|
|
|
.Fa timerid ,
|
|
|
|
|
previously created by the
|
2005-11-18 11:53:23 +00:00
|
|
|
.Xr timer_create 2
|
|
|
|
|
system call.
|
|
|
|
|
If the timer is armed when
|
2005-11-11 07:48:38 +00:00
|
|
|
.Fn timer_delete
|
|
|
|
|
is called, the behavior is as if the timer is automatically disarmed before
|
2005-11-18 11:53:23 +00:00
|
|
|
removal.
|
|
|
|
|
Pending signals for the deleted timer are cleared.
|
2005-11-11 07:48:38 +00:00
|
|
|
.Sh RETURN VALUES
|
2005-11-18 11:53:23 +00:00
|
|
|
.Rv -std
|
2005-11-11 07:48:38 +00:00
|
|
|
.Sh ERRORS
|
|
|
|
|
The
|
|
|
|
|
.Fn timer_delete
|
2005-11-18 11:53:23 +00:00
|
|
|
system call
|
2005-11-11 07:48:38 +00:00
|
|
|
will fail if:
|
|
|
|
|
.Bl -tag -width Er
|
|
|
|
|
.It Bq Er EINVAL
|
2005-11-18 11:53:23 +00:00
|
|
|
The timer ID specified by
|
|
|
|
|
.Fa timerid
|
|
|
|
|
is not a valid timer ID.
|
2005-11-11 07:48:38 +00:00
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr timer_create 2
|
|
|
|
|
.Sh STANDARDS
|
|
|
|
|
The
|
|
|
|
|
.Fn timer_delete
|
2005-11-18 11:53:23 +00:00
|
|
|
system call conforms to
|
2005-11-30 04:15:44 +00:00
|
|
|
.St -p1003.1-2004
|
|
|
|
|
.Sh HISTORY
|
|
|
|
|
Support for POSIX per-process timer first appeared in
|
|
|
|
|
.Fx 7.0 .
|
