Project

General

Profile

Submit #1699 » 0002-callout.9-document-callout_reset_-m-s.patch

C++, 03/20/2010 01:39 AM

View differences:

share/man/man9/Makefile
callout.9 callout_init_mp.9 \
callout.9 callout_pending.9 \
callout.9 callout_reset.9 \
callout.9 callout_reset_ms.9 \
callout.9 callout_reset_s.9 \
callout.9 callout_stop.9 \
callout.9 timeout.9 \
callout.9 untimeout.9
share/man/man9/callout.9
.Nm callout_init ,
.Nm callout_init_mp ,
.Nm callout_reset ,
.Nm callout_reset_s ,
.Nm callout_reset_ms ,
.Nm callout_stop ,
.Nm callout_active ,
.Nm callout_pending ,
......
.Fn callout_init_mp "struct callout *c"
.Ft void
.Fn callout_reset "struct callout *c" "int ticks" "timeout_t *func" "void *arg"
.Ft void
.Fn callout_reset_s "struct callout *c" "int s" "timeout_t *func" "void *arg"
.Ft void
.Fn callout_reset_ms "struct callout *c" "int ms" "timeout_t *func" "void *arg"
.Ft int
.Fn callout_stop "struct callout *c"
.Ft int
......
will be called with the argument
.Fa arg .
.Pp
The
.Fn callout_reset_s
and
.Fn callout_reset_ms
functions can be used in place of the
.Fn callout_reset
function with the timeout value expressed
in seconds and milliseconds, respectively.
.Pp
The function
.Fn callout_stop
cancels the callout associated with the callout handle
(2-2/2)