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

TimedSource Element Documentation

NAME

TimedSource -- Click element; periodically generates a packet

SYNOPSIS

TimedSource([INTERVAL, DATA, KEYWORDS])

Ports: no inputs, 1 output
Processing: push
Package: standard (core)

DESCRIPTION

Creates packets consisting of DATA. Pushes such a packet out its single output about once every INTERVAL seconds. Default INTERVAL is 500 milliseconds; default DATA is at least 64 bytes long. Keyword arguments are:

DATA
String. Same as the DATA argument.
INTERVAL
Time. Same as the INTERVAL argument.
LIMIT
Integer. Stops sending after LIMIT packets are generated; but if LIMIT is negative, sends packets forever.
HEADROOM
Unsigned integer. Sets the amount of headroom on generated packets. Default is the default packet headroom.
STOP
Boolean. If true, then stop the driver once LIMIT packets are sent. Default is false.

EXAMPLES

  TimedSource(INTERVAL 0.333) -> ...

ELEMENT HANDLERS

data (read/write)
Returns or sets the DATA parameter.
interval (read/write)
Returns or sets the INTERVAL parameter.

SEE ALSO

InfiniteSource

Generated by 'click-elem2man' from '../elements/standard/timedsource.hh' on 7/Mar/2009.

COMMENTS

 
elements/timedsource.txt · Last modified: 2009/03/07 17:24 (external edit)
 
Recent changes RSS feed Driven by DokuWiki