<box begindoc>**This is automatically generated documentation.**  Edit after the "[[#COMMENTS|COMMENTS]]" heading; changes to the main body will be lost.</box>

====== InfiniteSource Element Documentation ======

===== NAME =====

**InfiniteSource** -- Click element;
generates packets whenever scheduled

===== SYNOPSIS =====

InfiniteSource([DATA, LIMIT, BURST, ACTIVE, //KEYWORDS//])

**Ports**: no inputs, 1 output\\ 
**Processing**: agnostic\\ 
**Package**: standard (core)\\ 

===== DESCRIPTION =====

Creates packets consisting of DATA. Pushes BURST such packets out its single
output every time it is scheduled (which will be often). Stops sending after
LIMIT packets are generated; but if LIMIT is negative, sends packets forever.
Will send packets only if ACTIVE is true. (ACTIVE is true by default.) Default
DATA is at least 64 bytes long. Default LIMIT is -1 (send packets forever).
Default BURST is 1.
Keyword arguments are:


 ? **DATA**
 ! String. Same as the DATA argument.

 ? **DATASIZE**
 ! Integer. If set, ensures the outgoing packet contains at least this many bytes.

 ? **LIMIT**
 ! Integer. Same as the LIMIT argument.

 ? **BURST**
 ! Integer. Same as the BURST argument.

 ? **ACTIVE**
 ! Boolean. Same as the ACTIVE argument.

 ? **STOP**
 ! Boolean. If true, then stop the driver once LIMIT packets are sent. Default is
false.
To generate a particular traffic pattern, use this element and [[RatedSource]]
in conjunction with [[PokeHandlers]].

===== EXAMPLES =====


    InfiniteSource(\<0800>) -> Queue -> ...


===== NOTES =====

Useful for profiling and experiments.  Packets' timestamp annotations are set
to the current time.
InfiniteSource listens for downstream full notification.


===== ELEMENT HANDLERS =====


 ? **count (read-only)**
 ! Returns the total number of packets that have been generated.

 ? **reset (write-only)**
 ! Resets the number of generated packets to 0. The InfiniteSource will then
generate another LIMIT packets (if it is active).

 ? **data (read/write)**
 ! Returns or sets the DATA parameter.

 ? **datasize (read/write)**
 ! Returns or sets the DATASIZE parameter.

 ? **limit (read/write)**
 ! Returns or sets the LIMIT parameter.

 ? **burstsize (read/write)**
 ! Returns or sets the BURSTSIZE parameter.

 ? **active (read/write)**
 ! Makes the element active or inactive.


===== SEE ALSO =====

[[RatedSource]], [[PokeHandlers]]


Generated by 'click-elem2man' from '../elements/standard/infinitesource.hh' on 18/Sep/2007.


===== COMMENTS =====