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

NullTask Element Documentation

NAME

NullTask -- Click element; associated with a do-nothing Task

SYNOPSIS

NullTask([<keyword> LIMIT, STOP, ACTIVE])

Ports: none
Package: test (core)

DESCRIPTION

NullTask simply schedule a task which, when scheduled, does nothing. This can be useful for benchmarking.

LIMIT
Unsigned. NullTask will schedule itself at most LIMIT times. 0 means forever. Default is 0.
STOP
Boolean. If true, NullTask will stop the driver when LIMIT is reached. Default is false.
ACTIVE
Boolean. If false, NullTask will not schedule itself at initialization time. Use the scheduled write handler to schedule the task later. Default is true.

ELEMENT HANDLERS

count (read-only)
Returns the number of times the element has been scheduled.
reset (write-only)
Resets the count to 0.

SEE ALSO

ScheduleInfo

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

COMMENTS

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