.\"	$OpenBSD: timeout.9,v 1.26 2008/07/23 11:45:21 art Exp $
.\"
.\" Copyright (c) 2000 Artur Grabowski <art@openbsd.org>
.\" All rights reserved.
.\"
.\" 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. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED ``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 AUTHOR 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 $Mdocdate: July 23 2008 $
.Dt TIMEOUT 9
.Os
.Sh NAME
.Nm timeout_set ,
.Nm timeout_add ,
.Nm timeout_del ,
.Nm timeout_pending ,
.Nm timeout_initialized ,
.Nm timeout_triggered
.Nd execute a function after a specified period of time
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/timeout.h>
.Ft void
.Fn "timeout_set" "struct timeout *to" "void (*fn)(void *)" "void *arg"
.Ft void
.Fn "timeout_add" "struct timeout *to" "int ticks"
.Ft void
.Fn "timeout_del" "struct timeout *to"
.Ft int
.Fn "timeout_pending" "struct timeout *to"
.Ft int
.Fn "timeout_initialized" "struct timeout *to"
.Ft int
.Fn "timeout_triggered" "struct timeout *to"
.Ft void
.Fn "timeout_add_tv" "struct timeout *to" "struct timeval *"
.Ft void
.Fn "timeout_add_ts" "struct timeout *to" "struct timespec *"
.Ft void
.Fn "timeout_add_bt" "struct timeout *to" "struct bintime *"
.Ft void
.Fn "timeout_add_sec" "struct timeout *to" "int sec"
.Ft void
.Fn "timeout_add_usec" "struct timeout *to" "int sec"
.Ft void
.Fn "timeout_add_nsec" "struct timeout *to" "int sec"
.Sh DESCRIPTION
The
.Nm timeout
API provides a mechanism to execute a function at a given time.
The granularity of the time is limited by the granularity of the
.Xr hardclock 9
timer which executes
.Xr hz 9
times a second.
The function will be called at softclock interrupt level.
.Pp
It is the responsibility of the caller to provide these functions with
pre-allocated timeout structures.
All functions in this API may be used in interrupt context below
.Fn splclock .
.Pp
This API replaces the historic functions
.Fn timeout
and
.Fn untimeout .
.Pp
The function
.Fn timeout_set
prepares the timeout structure
.Fa to
to be used in future calls to
.Fn timeout_add
and
.Fn timeout_del .
The timeout will be prepared to call the function specified by the
.Fa fn
argument with a
.Fa void *
argument given in the
.Fa arg
argument.
Once initialized, the
.Fa to
structure can be used repeatedly in
.Fn timeout_add
and
.Fn timeout_del
and does not need to be reinitialized unless
the function called and/or its argument must change.
.Pp
The function
.Fn timeout_add
schedules the execution of the
.Fa to
timeout in at least
.Fa ticks Ns /hz
seconds.
Negative values of
.Fa ticks
are illegal.
If the value is
.Sq 0
it will, in the current implementation, be treated as
.Sq 1 ,
but in the future it might cause an immediate timeout.
The timeout in the
.Fa to
argument must be already initialized by
.Fn timeout_set
and may not be used in calls to
.Fn timeout_set
until it has timed out or been removed with
.Fn timeout_del .
If the timeout in the
.Fa to
argument is already scheduled, the old execution time will be
replaced by the new one.
.Pp
The function
.Fn timeout_del
will cancel the timeout in the argument
.Fa to .
If the timeout has already executed or has never been added
the call will have no effect.
.Pp
The
.Fn timeout_pending
macro can be used to check if a timeout is scheduled to run.
.Pp
The
.Fn timeout_initialized
macro can be used to check if a timeout has been initialized.
.Pp
The
.Fn timeout_triggered
macro can be used to check if a timeout is running or has been run.
The
.Fn timeout_add
and
.Fn timeout_del
functions clear the triggered state for that timeout.
.Pp
When possible, instead of using
.Fn timeout_add
the functions
.Fn timeout_add_tv ,
.Fn timeout_add_ts ,
.Fn timeout_add_bt ,
.Fn timeout_add_sec ,
.Fn timeout_add_usec ,
.Fn timeout_add_nsec
should be used.
Those functions add a timeout doing conversion of the time specified
by their respective types.
.Sh CODE REFERENCES
These functions are implemented in the file
.Pa sys/kern/kern_timeout.c .
.Sh SEE ALSO
.Xr hz 9 ,
.Xr hzto 9 ,
.Xr splclock 9 ,
.Xr tsleep 9 ,
.Xr tvtohz 9