Document timeout_pending and timeout_initialized.
authorart <art@openbsd.org>
Thu, 23 Mar 2000 11:15:21 +0000 (11:15 +0000)
committerart <art@openbsd.org>
Thu, 23 Mar 2000 11:15:21 +0000 (11:15 +0000)
share/man/man9/timeout.9

index 8659c07..cd69e6f 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: timeout.9,v 1.3 2000/03/23 10:10:20 art Exp $
+.\"    $OpenBSD: timeout.9,v 1.4 2000/03/23 11:15:21 art Exp $
 .\"
 .\" Copyright (c) 2000 Artur Grabowski <art@openbsd.org>
 .\" All rights reserved. 
@@ -40,6 +40,8 @@
 .Fn "timeout_set" "struct timeout *to" "void (*fn)(void *)" "void *arg"
 .Fn "timeout_add" "struct timeout *to" "int ticks"
 .Fn "timeout_del" "struct timeout *to"
+.Fn "timeout_pending" "struct timeout *to"
+.Fn "timeout_initialized" "struct timeout *to"
 .Sh DESCRIPTION
 The finction
 .Fn timeout_set
@@ -98,6 +100,14 @@ will cancel the timeout in the argument
 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
 It's the caller responsibility to provide those functions with
 the timeout structures. No functions in this API will do memory
 allocation. All functions in this API may be called in interrupt