[src/trunk]: src/share/man/man9 Document callout_active().

[mycroft <mycroft%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/2e6ef2a84201
branches:  trunk
changeset: 574541:2e6ef2a84201
user:      mycroft <mycroft%NetBSD.org@localhost>
date:      Fri Mar 04 05:53:19 2005 +0000

description:
Document callout_active().

diffstat:

 share/man/man9/callout.9 |  21 +++++++++++++++++++--
 1 files changed, 19 insertions(+), 2 deletions(-)

diffs (49 lines):

diff -r 1b760a2c9f57 -r 2e6ef2a84201 share/man/man9/callout.9
--- a/share/man/man9/callout.9  Fri Mar 04 05:51:41 2005 +0000
+++ b/share/man/man9/callout.9  Fri Mar 04 05:53:19 2005 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: callout.9,v 1.13 2003/10/27 16:52:01 thorpej Exp $
+.\"    $NetBSD: callout.9,v 1.14 2005/03/04 05:53:19 mycroft Exp $
 .\"
 .\" Copyright (c) 2000, 2003 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -34,7 +34,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd October 26, 2003
+.Dd March 4, 2005
 .Dt CALLOUT 9
 .Os
 .Sh NAME
@@ -67,6 +67,8 @@
 .Ft int
 .Fn "callout_expired" "struct callout *c"
 .Ft int
+.Fn "callout_active" "struct callout *c"
+.Ft int
 .Fn "callout_invoking" "struct callout *c"
 .Ft void
 .Fn "callout_ack" "struct callout *c"
@@ -192,6 +194,21 @@
 function called.
 .Pp
 The
+.Fn callout_active
+function returns true if a timer has been started but not explicitly stopped,
+even if it has already fired.
+.Fn callout_active foo
+is logically the same as
+.Fn callout_pending foo
+||
+.Fn callout_expired foo ;
+it is implemented as a separate function for compatibility with
+.Fx
+and for the special case of
+.Fn TCP_TIMER_ISARMED .
+Its use is not recommended.
+.Pp
+The
 .Fn callout_invoking
 function tests the
 .Em INVOKING