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

AverageCounter Element Documentation

NAME

AverageCounter -- Click element; measures historical packet count and rate

SYNOPSIS

AverageCounter([IGNORE])

Ports: 1 input, 1 output
Processing: agnostic
Package: standard (core)

DESCRIPTION

Passes packets unchanged from its input to its output, maintaining statistics information about packet count and packet rate using a strict average. The rate covers only the time between the first and most recent packets. IGNORE, by default, is 0. If it is greater than 0, the first IGNORE number of seconds are ignored in the count.

ELEMENT HANDLERS

count (read-only)
Returns the number of packets that have passed through since the last reset.
byte_count (read-only)
Returns the number of packets that have passed through since the last reset.
rate (read-only)
Returns packet arrival rate.
byte_rate (read-only)
Returns packet arrival rate in bytes per second. (Beware overflow!)
reset (write-only)
Resets the count and rate to zero.

Generated by 'click-elem2man' from '../elements/standard/averagecounter.hh' on 7/Mar/2009.

COMMENTS

 
elements/averagecounter.txt · Last modified: 2009/03/07 17:24 (external edit)
 
Recent changes RSS feed Driven by DokuWiki