Skip to content

BandwidthRatedUnqueue

Tom Barbette edited this page May 7, 2020 · 3 revisions

BandwidthRatedUnqueue Element Documentation

NAME

BandwidthRatedUnqueue — Click element; pull-to-push converter

SYNOPSIS

BandwidthRatedUnqueue(RATE, I[])

Batching: Batching natively supported
Ports: 1 input, 1 output
Processing: pull inputs, push outputs

DESCRIPTION

Pulls packets at the given RATE, and pushes them out its single output. This 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.
  • EXTRA_LENGTH — Boolean. If true, then the length of the packet in the EXTRA_LENGTH annotation will be taken into account. Default to false.
  • LINK_RATE — Boolean. If true, the given RATE is considered as a link rate, in bits/s, taking into account inter-frame, preamble and FCS for each packets. FCS is assumed to be stripped (hence, 24 bytes are added per-packets).

ELEMENT HANDLERS

  • rate (read/write) —

SEE ALSO

RatedUnqueue, Unqueue, BandwidthShaper, BandwidthRatedSplitter

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

Clone this wiki locally