This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.
Shaper Element Documentation
NAME
Shaper -- Click element; shapes traffic to maximum rate (pkt/s)
SYNOPSIS
Shaper(RATE)
Ports: 1 input, 1 output
Processing: pull
Package: standard (core)
DESCRIPTION
Shaper is a pull element that allows a maximum of RATE packets per second to pass through. That is, traffic is shaped to RATE packets per second. Shaper is dependent on the timing of its pull requests; if it receives only sporadic pull requests, then it will emit packets only sporadically. However, if it receives a large number of evenly-spaced pull requests, then it will emit packets at the specified RATE with low burstiness.
NOTES
Shaper cannot implement every rate smoothly. For example, it can smoothly generate 1000000 packets per second and 1000244 packets per second, but not rates in between. (In-between rates will result in minor burstiness.) This granularity issue is negligible at low rates, and becomes serious at very high rates; for example, Shaper cannot smoothly implement any rate between 2.048e10 and 4.096e10 packets per second.
ELEMENT HANDLERS
- rate (read/write)
- Returns or sets the RATE parameter.
SEE ALSO
BandwidthShaper, RatedSplitter, RatedUnqueue
Generated by 'click-elem2man' from '../elements/standard/shaper.hh' on 7/Mar/2009.
