FastClick

Elements / Shaping

BandwidthMeter

classifies packet stream by arrival rate

SYNOPSIS§

BandwidthMeter(RATE1, RATE2, ..., RATEn)

Ports: 1 input, 2 or more outputs
Processing: push

DESCRIPTION§

Classifies packet stream based on the rate of packet arrival. The rate is measured in bytes per second using an exponential weighted moving average. (The related Meter element measures rates in packets per second.)

The configuration string consists of one or more RATE arguments. Each RATE is a bandwidth, such as "384 kbps". Earlier rates in the list must be less than later rates. A Meter with n rate arguments will have n+1 outputs. It sends packets out the output corresponding to the current rate. If the rate is less than RATE1 packets are sent to output 0; if it is >= RATE1 but < RATE2, packets are sent to output 1; and so on. If it is >= RATEn, packets are sent to output n.

EXAMPLES§

This configuration fragment drops the input stream when it is generating more than 20,000 bytes per second.

 ... -> m :: BandwidthMeter(20kBps) -> ...;
 m[1] -> Discard;

SEE ALSO§

Meter, BandwidthShaper, Shaper, RatedSplitter

Generated by click-elem2man from ../elements/standard/bandwidthmeter.hh:7 on 2026/11/02.