Table of Contents
This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.
Discard Element Documentation
NAME
Discard -- Click element; drops all packets
SYNOPSIS
Discard([keywords ACTIVE, BURST])
Ports: 1 input, no outputs
Processing: agnostic
Package: standard (core)
DESCRIPTION
Discards all packets received on its single input. If used in a pull context, it initiates pulls whenever packets are available, and listens for activity notification, such as that available from Queue. Keyword arguments are:
- ACTIVE
- Boolean. If false, then Discard does not pull packets. Default is true. Only meaningful in pull context.
- BURST
- Unsigned. Number of packets to pull per scheduling. Default is 1. Only meaningful in pull context.
ELEMENT HANDLERS
- active (read/write)
- Returns or sets the ACTIVE parameter. Only present if Discard is in pull context.
- count (read-only)
- Returns the number of packets discarded.
- reset_counts (write-only)
- Resets "count" to 0.
SEE ALSO
Generated by 'click-elem2man' from '../elements/standard/discard.hh:8' on 12/Jul/2011.
