Table of Contents
This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.
Unqueue Element Documentation
NAME
Unqueue -- Click element; pull-to-push converter
SYNOPSIS
Unqueue([BURST, KEYWORDS])
Ports: 1 input, 1 output
Processing: pull inputs, push outputs
Package: standard (core)
DESCRIPTION
Pulls packets whenever they are available, then pushes them out its single output. Pulls a maximum of BURST packets every time it is scheduled. Default BURST is 1. If BURST is less than 0, pull until nothing comes back. Keyword arguments are:
- ACTIVE
- If false, does nothing (doesn't pull packets). One possible use is to set ACTIVE to false in the configuration, and later change it to true with a handler from DriverManager element. The default value is true.
ELEMENT HANDLERS
- count (read-only)
- Returns the count of packets that have passed through Unqueue.
- active (read/write)
- The same as ACTIVE keyword.
SEE ALSO
RatedUnqueue, BandwidthRatedUnqueue
Generated by 'click-elem2man' from '../elements/standard/unqueue.hh' on 18/Sep/2007.
