BandwidthRatedSplitter

BandwidthRatedSplitter Element Documentation

NAME

BandwidthRatedSplitter — Click element; splits flow of packets at specified bandwidth rate

SYNOPSIS

BandwidthRatedSplitter(RATE, I[])

Batching: Batching natively supported
Ports: 1 input, 1-2 outputs
Processing: Push

DESCRIPTION

BandwidthRatedSplitter has two output ports. All incoming packets up to a maximum of RATE are emitted on output port 0. Any remaining packets are emitted on output port 1. RATE is a bandwidth, such as "384 kbps". Unlike BandwidthMeter, the base RATE is emitted on output port 0 even when the input rate is greater than RATE.

The rate is implemented using a token bucket. The capacity of this token bucket defaults to 20 milliseconds worth of tokens, but can be customized by setting one of BURST_DURATION or BURST_SIZE.

Keyword arguments are:

• RATE — Bandwidth. Token bucket fill rate.
• BURST_DURATION — Time. If specified, the capacity of the token bucket is calculated as rate * burst_duration.
• BURST_BYTES — Integer. If specified, the capacity of the token bucket is set to this value in bytes.

ELEMENT HANDLERS

• rate (read/write) — rate of splitting

SEE ALSO

RatedSplitter, BandwidthMeter, BandwidthShaper, BandwidthRatedUnqueue

Generated by click-elem2man from ../elements/standard/bwratedsplitter.hh:8 on 2020/05/07.