This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.

TimerTest Element Documentation

NAME

TimerTest -- Click element; runs regression tests for Timer

SYNOPSIS

TimerTest([keywords])

Ports: none
Package: test (core)

DESCRIPTION

Without other arguments, TimerTest runs regression tests for Click's Timer class at initialization time. TimerTest includes a timer which prints a message when scheduled. This timer is controlled by the DELAY and/or SCHEDULED keyword arguments and several handlers. TimerTest does not route packets. Keyword arguments are:

DELAY
Timestamp. If set, TimerTest schedules a timer starting DELAY seconds in the future. On expiry, a message such as "1000000000.010000: t1 :: TimerTest fired" is printed to standard error.
BENCHMARK
Integer. If set to a positive number, then TimerTest runs a timer manipulation benchmark at installation time involving BENCHMARK total timers. Default is 0 (don't benchmark).

ELEMENT HANDLERS

scheduled (read/write)
Boolean. Returns whether the TimerTest's timer is scheduled.
expiry (read-only)
Timestamp. Returns the expiration time for the TimerTest's timer, if any.
schedule_after (write-only)
Schedule the TimerTest's timer to fire after a given time.
unschedule (write-only)
Unschedule the TimerTest's timer.

Generated by 'click-elem2man' from '../elements/test/timertest.hh:8' on 12/Jul/2011.

COMMENTS

 
elements/timertest.txt · Last modified: 2011/07/12 11:29 (external edit)
 
Recent changes RSS feed Driven by DokuWiki