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

ThreadSafeQueue Element Documentation

NAME

ThreadSafeQueue -- Click element; stores packets in a FIFO queue

SYNOPSIS

ThreadSafeQueue
ThreadSafeQueue(CAPACITY)

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

DESCRIPTION

Stores incoming packets in a first-in-first-out queue. Drops incoming packets if the queue already holds CAPACITY packets. The default for CAPACITY is 1000. This variant of the default Queue is (should be) completely thread safe, in that it supports multiple concurrent pushers and pullers. In all respects other than thread safety it behaves just like Queue, and like Queue it has non-full and non-empty notifiers.

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.
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, NotifierQueue, MixedQueue, FrontDropQueue

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

COMMENTS

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