RatedUnqueue

RatedUnqueue Element Documentation

NAME

RatedUnqueue — Click element; pull-to-push converter

SYNOPSIS

RatedUnqueue(RATE, I[])

Ports: 1 input, 1 output
Processing: pull inputs, push outputs

DESCRIPTION

Pulls packets at the given RATE in packets per second, and pushes them out its single output. It is implemented with a token bucket. The capacity of this token bucket defaults to 20 milliseconds worth of tokens, but can be customized by setting BURST_DURATION or BURST_SIZE.

Keyword arguments are:

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

ELEMENT HANDLERS

• rate (read/write) —

SEE ALSO

BandwidthRatedUnqueue, Unqueue, Shaper, RatedSplitter

Generated by click-elem2man from ../elements/standard/ratedunqueue.hh:11 on 2017/10/17.