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

FrontDropQueue Element Documentation

NAME

FrontDropQueue -- Click element; stores packets in drop-from-front FIFO queue

SYNOPSIS

FrontDropQueue
FrontDropQueue(CAPACITY)

Ports: 1 input, 1-2 outputs
Package: standard (core)

DESCRIPTION

Stores incoming packets in a first-in-first-out queue. Drops the head packet before inserting the incoming packet if the queue already holds CAPACITY packets. The default for CAPACITY is 1000.

ELEMENT HANDLERS

length (read-only)
Returns the current number of packets in the queue.
highwater_length (read-only)
Returns the maximum number of packets that have ever been in the queue at once.
capacity (read/write)
Returns or sets the queue's capacity.
drops (read-only)
Returns the number of packets dropped by the Queue so far. Dropped packets are emitted on output 1 if output 1 exists.
reset_counts (write-only)
When written, resets the drops and highwater_length counters.
reset (write-only)
When written, drops all packets in the Queue.

SEE ALSO

Queue, SimpleQueue, MixedQueue, RED

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

COMMENTS

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