RatedSplitter Element Documentation
- NAME
- SYNOPSIS
- DESCRIPTION
- EXAMPLES
- ELEMENT HANDLERS
- SEE ALSO
- COMMENTS

This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.

RatedSplitter Element Documentation

NAME

RatedSplitter -- Click element; splits flow of packets at specified rate

SYNOPSIS

RatedSplitter(RATE)

Ports: 1 input, 2 outputs
Processing: push
Package: standard (core)

RatedSplitter has two output ports. All incoming packets up to a maximum of RATE packets per second are emitted on output port 0. Any remaining packets are emitted on output port 1. Unlike Meter, RATE packets per second are emitted on output port 0 even when the input rate is greater than RATE.

EXAMPLES

  rs :: RatedSplitter(2000);

Split packets on port 0 at 2000 packets per second.

  elementclass RatedSampler {
    input -> rs :: RatedSplitter(2000);
    rs [0] -> t :: Tee;
    t [0] -> [0] output;
    t [1] -> [1] output;
    rs [1] -> [0] output;
  };

In the above example, RatedSampler is a compound element that samples input packets at 2000 packets per second. All traffic is emitted on output 0; a maximum of 2000 packets per second are emitted on output 1 as well.

ELEMENT HANDLERS

rate (read/write): rate of splitting

COMMENTS