CoDelPriorityBlockingQueue (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractQueue<E>
  - - java.util.concurrent.PriorityBlockingQueue<E>
    - - net.i2p.router.util.PriBlockingQueue<E>
      - net.i2p.router.util.CoDelPriorityBlockingQueue<E>

Type Parameters:
E - type of elements in this queue, extending CDPQEntry
All Implemented Interfaces:
Serializable, Iterable<E>, Collection<E>, BlockingQueue<E>, Queue<E>
```
public class CoDelPriorityBlockingQueue<E extends CDPQEntry>
extends PriBlockingQueue<E>
```
CoDel (Controlled Delay) implementation with priority-based queue management.
Extends CoDelBlockingQueue to add priority-based dropping functionality. Implements enhanced CoDel algorithm with configurable priority thresholds and per-priority statistics.
Provides priority-aware packet dropping where higher priority packets are protected from dropping during congestion events. Includes comprehensive statistics tracking and performance monitoring for different priority levels.
Input methods are overridden to add timestamps for delay calculation. Output methods implement AQM behavior with enhanced statistics tracking for priority-based operations.
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static AtomicLong`	`__id` debugging
`static int`	`DONT_DROP_PRIORITY` if priority is >= this, never drop
`static int`	`MIN_PRIORITY` min priority
`static String`	`PROP_CODEL_INTERVAL` Property key for CoDel interval
`static String`	`PROP_CODEL_TARGET` Property key for CoDel target delay

Fields inherited from class net.i2p.router.util.PriBlockingQueue
_context, _log, _name, DEFAULT_BACKLOG_SIZE, DEFAULT_MAX_SIZE, PROP_BACKLOG_SIZE, PROP_MAX_SIZE

Constructor Summary

Constructors
Constructor and Description
`CoDelPriorityBlockingQueue(I2PAppContext ctx, String name, int initialCapacity)` Constructs a new CoDel priority blocking queue with default target and interval.
`CoDelPriorityBlockingQueue(I2PAppContext ctx, String name, int initialCapacity, int target, int interval)` Constructs a new CoDel priority blocking queue with explicit target and interval.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` clear.
`void`	`dispose()` Remove this instance from the tuning list.
`int`	`drainAllTo(Collection<? super E> c)` Drains all, without updating stats or dropping.
`int`	`drainTo(Collection<? super E> c)` Updates stats and possibly drops while draining.
`int`	`drainTo(Collection<? super E> c, int maxElements)` Updates stats and possibly drops while draining.
`static void`	`expungeStaleInstances()` Remove cleared (GC'd) weak references from the list.
`long`	`getInterval()` Returns the current CoDel interval in ms.
`long`	`getTarget()` Returns the current CoDel target delay in ms.
`boolean`	`isBacklogged()` Has the head of the queue been waiting too long, or is the queue too big?
`E`	`poll()` poll.
`void`	`setInterval(long interval)` Sets the current CoDel interval in ms.
`void`	`setTarget(long target)` Sets the current CoDel target delay in ms.
`E`	`take()` take.
`protected void`	`timestamp(E o)` timestamp.
`static void`	`updateAllIntervals(long interval)` Update the interval for all active instances.
`static void`	`updateAllTargets(long target)` Update the target delay for all active instances.

Methods inherited from class net.i2p.router.util.PriBlockingQueue
offer

Methods inherited from class java.util.concurrent.PriorityBlockingQueue
add, comparator, contains, iterator, offer, peek, poll, put, remainingCapacity, remove, size, spliterator, toArray, toArray, toString

Methods inherited from class java.util.AbstractQueue
addAll, element, remove

Methods inherited from class java.util.AbstractCollection
containsAll, isEmpty, removeAll, retainAll

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Queue
element, remove

Methods inherited from interface java.util.Collection
addAll, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - __id
```
static final AtomicLong __id
```
    debugging
  - DONT_DROP_PRIORITY
```
public static final int DONT_DROP_PRIORITY
```
    if priority is >= this, never drop
    See Also:
    Constant Field Values
  - MIN_PRIORITY
```
public static final int MIN_PRIORITY
```
    min priority
    See Also:
    Constant Field Values
  - PROP_CODEL_INTERVAL
```
public static final String PROP_CODEL_INTERVAL
```
    Property key for CoDel interval
    See Also:
    Constant Field Values
  - PROP_CODEL_TARGET
```
public static final String PROP_CODEL_TARGET
```
    Property key for CoDel target delay
    See Also:
    Constant Field Values
- Constructor Detail
  - CoDelPriorityBlockingQueue
```
public CoDelPriorityBlockingQueue(I2PAppContext ctx,
                                  String name,
                                  int initialCapacity)
```
    Constructs a new CoDel priority blocking queue with default target and interval.
    Parameters:
    ctx - the I2P application context
    name - a name for this queue instance
    initialCapacity - the initial capacity for the priority queue
  - CoDelPriorityBlockingQueue
```
public CoDelPriorityBlockingQueue(I2PAppContext ctx,
                                  String name,
                                  int initialCapacity,
                                  int target,
                                  int interval)
```
    Constructs a new CoDel priority blocking queue with explicit target and interval.
    Parameters:
    ctx - the I2P application context
    name - for stats
    initialCapacity - the initial capacity for the priority queue
    target - the CoDel target delay in ms
    interval - the CoDel interval in ms
- Method Detail
  - clear
```
public void clear()
```
    clear.
    Specified by:
    clear in interface Collection<E extends CDPQEntry>
    Overrides:
    clear in class PriorityBlockingQueue<E extends CDPQEntry>
  - dispose
```
public void dispose()
```
    Remove this instance from the tuning list.
  - drainAllTo
```
public int drainAllTo(Collection<? super E> c)
```
    Drains all, without updating stats or dropping.
    Parameters:
    c - the collection to drain into
    Returns:
    the number of elements drained
  - drainTo
```
public int drainTo(Collection<? super E> c)
```
    Updates stats and possibly drops while draining.
    Specified by:
    drainTo in interface BlockingQueue<E extends CDPQEntry>
    Overrides:
    drainTo in class PriorityBlockingQueue<E extends CDPQEntry>
  - drainTo
```
public int drainTo(Collection<? super E> c,
                   int maxElements)
```
    Updates stats and possibly drops while draining.
    Specified by:
    drainTo in interface BlockingQueue<E extends CDPQEntry>
    Overrides:
    drainTo in class PriorityBlockingQueue<E extends CDPQEntry>
  - expungeStaleInstances
```
public static void expungeStaleInstances()
```
    Remove cleared (GC'd) weak references from the list.
  - getInterval
```
public long getInterval()
```
    Returns the current CoDel interval in ms.
    Returns:
    the interval in ms
  - getTarget
```
public long getTarget()
```
    Returns the current CoDel target delay in ms.
    Returns:
    the target delay in ms
  - isBacklogged
```
public boolean isBacklogged()
```
    Has the head of the queue been waiting too long, or is the queue too big?
    Overrides:
    isBacklogged in class PriBlockingQueue<E extends CDPQEntry>
    Returns:
    whether backlogged
  - poll
```
public E poll()
```
    poll.
    Specified by:
    poll in interface Queue<E extends CDPQEntry>
    Overrides:
    poll in class PriorityBlockingQueue<E extends CDPQEntry>
  - setInterval
```
public void setInterval(long interval)
```
    Sets the current CoDel interval in ms.
    Parameters:
    interval - the new interval in ms
  - setTarget
```
public void setTarget(long target)
```
    Sets the current CoDel target delay in ms.
    Parameters:
    target - the new target delay in ms
  - take
```
public E take()
       throws InterruptedException
```
    take.
    Specified by:
    take in interface BlockingQueue<E extends CDPQEntry>
    Overrides:
    take in class PriorityBlockingQueue<E extends CDPQEntry>
    Throws:
    InterruptedException
  - timestamp
```
protected void timestamp(E o)
```
    timestamp.
    Overrides:
    timestamp in class PriBlockingQueue<E extends CDPQEntry>
    Parameters:
    o - the element to timestamp
  - updateAllIntervals
```
public static void updateAllIntervals(long interval)
```
    Update the interval for all active instances.
    Parameters:
    interval - the new interval in ms
  - updateAllTargets
```
public static void updateAllTargets(long target)
```
    Update the target delay for all active instances.
    Parameters:
    target - the new target delay in ms

Class CoDelPriorityBlockingQueue<E extends CDPQEntry>

Field Summary

Fields inherited from class net.i2p.router.util.PriBlockingQueue

Constructor Summary

Method Summary

Methods inherited from class net.i2p.router.util.PriBlockingQueue

Methods inherited from class java.util.concurrent.PriorityBlockingQueue

Methods inherited from class java.util.AbstractQueue

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Queue

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

__id

DONT_DROP_PRIORITY

MIN_PRIORITY

PROP_CODEL_INTERVAL

PROP_CODEL_TARGET

Constructor Detail

CoDelPriorityBlockingQueue

CoDelPriorityBlockingQueue

Method Detail

clear

dispose

drainAllTo

drainTo

drainTo

expungeStaleInstances

getInterval

getTarget

isBacklogged

poll

setInterval

setTarget

take

timestamp

updateAllIntervals

updateAllTargets