Skip to content

AverageBatchCounter

Tom Barbette edited this page Nov 25, 2022 · 4 revisions

AverageBatchCounter Element Documentation

NAME

AverageBatchCounter — Click element; keep average statistics about batching since last reset and last tick

SYNOPSIS

AverageBatchCounter([INTERVAL, LENGTH_STATS])

Batching: Batching natively supported
Ports: 1 input, 1 output
Processing: agnostic

DESCRIPTION

Expects Ethernet frames as input. Computes statistics related to the batches being created either since the last tick or since the initialization of the element. If LENGTH_STATS is set to true, this element should be combined with an upstream AggregateLength element, which provides frames' length.

Keyword arguments are:

  • INTERVAL — Integer. Time interval to reschedule the computation of the statistics. Defaults to 1000 ms.
  • LENGTH_STATS — Boolean. If set, provides additional statistics regarding frames' length. Defaults to false.

ELEMENT HANDLERS

  • average (read-only) — Returns the average batch size (packets/batch) since the last tick.
  • average_total (read-only) — Returns the total average batch size (packets/batch).
  • count_packets (read-only) — Returns the number of packets seen since the last tick.
  • count_packets_total (read-only) — Returns the total number of packets seen.
  • count_batches (read-only) — Returns the number of batches created since the last tick.
  • count_batches_total (read-only) — Returns the total number of batches.
  • average_frame_len (read-only) — Returns the average frame length in bytes since the last tick.
  • average_frame_len_total (read-only) — Returns the total average frame length in bytes.

Generated by click-elem2man from ../elements/analysis/averagebatchcounter.hh:9 on 2022/11/25.

Clone this wiki locally