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

CycleCountAccum Element Documentation

NAME

CycleCountAccum -- Click element; collects differences in cycle counters

SYNOPSIS

CycleCountAccum()

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

DESCRIPTION

Incoming packets should have their cycle counter annotation set. Measures the current value of the cycle counter, and keeps track of the total accumulated difference. Packets whose cycle counter annotations are zero are not added to the count or difference.

NOTES

A packet has room for either exactly one cycle count or exactly one performance metric.

ELEMENT HANDLERS

count (read-only)
Returns the number of packets that have passed.
cycles (read-only)
Returns the accumulated cycles for all passing packets.
zero_count (read-only)
Returns the number of packets with zero-valued cycle counter annotations that have passed. These aren't included in the count.
reset_counts (write-only)
Resets count, cycles, and zero_count counters to zero when written.

SEE ALSO

SetCycleCount, RoundTripCycleCount, SetPerfCount, PerfCountAccum

Generated by 'click-elem2man' from '../elements/linuxmodule/cyclecountaccum.hh' on 24/May/2007.

COMMENTS

 
elements/cyclecountaccum.txt · Last modified: 2007/05/24 00:16 (external edit)
 
Recent changes RSS feed Driven by DokuWiki