TunnelGatewayPumper (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.tunnel.TunnelGatewayPumper

All Implemented Interfaces:
Runnable
```
class TunnelGatewayPumper
extends Object
implements Runnable
```
TunnelGatewayPumper runs a pool of threads that process PumpedTunnelGateway instances which need messages pushed through preprocessing and sending. This class is thread-safe and designed to manage concurrent producers (calling wantsPumping) and multiple consumer threads (pumper threads). Shutdown coordination: - The stopPumping() method sets a stop flag and enqueues a special poison pill for each thread. - Threads detect the poison pill and exit cleanly. - Threads are interrupted and joined to ensure complete termination. Thread safety notes: - Uses a LinkedBlockingQueue with bounded capacity for backpressure. - Uses a concurrent Set to track backlogged gateways for requeueing. - Non-blocking offer() with timeout prevents I2CP reader stalls. - Gateway drops are tracked via tunnel.pumperQueueFull stat.

Constructor Summary
Constructors
Constructor and Description
TunnelGatewayPumper(RouterContext ctx)
Creates a new TunnelGatewayPumper and starts configured number of pump threads.

Constructors
Constructor and Description
`TunnelGatewayPumper(RouterContext ctx)` Creates a new TunnelGatewayPumper and starts configured number of pump threads.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`adjustRunningThreads(int newCount)` Adjust the running instance's thread count.
`void`	`adjustThreads(int newCount)` Dynamically adjust the number of pumper threads.
`int`	`getActiveCount()` Get the number of pumper threads actively processing (not parked on take()).
`double`	`getInstanceUtilization()` Get pumper pool utilization as a ratio (0.0-1.0).
`static int`	`getMaxPumpers()` Get the current max pumper threads.
`static int`	`getQueueCapacity()` Get the current pumper queue capacity.
`static long`	`getRequeueTime()`
`static double`	`getUtilization()` Get pumper pool utilization as a ratio (0.0-1.0).
`void`	`resizeQueue(int newCapacity)` Resize the pumper queue.
`static void`	`resizeRunningQueue(int newCapacity)` Resize the running instance's queue.
`void`	`run()` Primary thread run loop.
`static void`	`setMaxPumpers(int max)` Set the max pumper threads.
`static void`	`setQueueCapacity(int capacity)` Set the pumper queue capacity.
`static void`	`setRequeueTime(long ms)`
`void`	`stopPumping()` Requests a graceful stop for pump threads.
`void`	`wantsPumping(PumpedTunnelGateway gw)` Requests pumping for a gateway.

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

- Constructor Detail
  - TunnelGatewayPumper
```
public TunnelGatewayPumper(RouterContext ctx)
```
    Creates a new TunnelGatewayPumper and starts configured number of pump threads.
    Parameters:
    ctx - the router context
- Method Detail
  - adjustRunningThreads
```
public static void adjustRunningThreads(int newCount)
```
    Adjust the running instance's thread count.
    Parameters:
    newCount - desired thread count
  - adjustThreads
```
public void adjustThreads(int newCount)
```
    Dynamically adjust the number of pumper threads. Adds threads if count increased, signals excess threads to stop if decreased.
    Parameters:
    newCount - desired thread count
  - getActiveCount
```
public int getActiveCount()
```
    Get the number of pumper threads actively processing (not parked on take()).
    Returns:
    the active count
  - getInstanceUtilization
```
public double getInstanceUtilization()
```
    Get pumper pool utilization as a ratio (0.0-1.0). Returns NaN if no pumpers are running.
    Returns:
    the instance utilization
  - getMaxPumpers
```
public static int getMaxPumpers()
```
    Get the current max pumper threads.
    Returns:
    the max pumpers
  - getQueueCapacity
```
public static int getQueueCapacity()
```
    Get the current pumper queue capacity.
    Returns:
    the queue capacity
  - getRequeueTime
```
public static long getRequeueTime()
```
  - getUtilization
```
public static double getUtilization()
```
    Get pumper pool utilization as a ratio (0.0-1.0). Returns NaN if not started.
    Returns:
    the utilization
  - resizeQueue
```
public void resizeQueue(int newCapacity)
```
    Resize the pumper queue. Drains old queue into new one.
    Parameters:
    newCapacity - new queue capacity
  - resizeRunningQueue
```
public static void resizeRunningQueue(int newCapacity)
```
    Resize the running instance's queue.
    Parameters:
    newCapacity - new capacity
  - run
```
public void run()
```
    Primary thread run loop. Picks gateways from the queue and pumps messages.
    Specified by:
    run in interface Runnable
  - setMaxPumpers
```
public static void setMaxPumpers(int max)
```
    Set the max pumper threads.
  - setQueueCapacity
```
public static void setQueueCapacity(int capacity)
```
    Set the pumper queue capacity. Does not resize existing queue; call resizeQueue(int) to apply to running instance.
  - setRequeueTime
```
public static void setRequeueTime(long ms)
```
  - stopPumping
```
public void stopPumping()
```
    Requests a graceful stop for pump threads. Clears queues and signals all pump threads to terminate. Waits for thread termination before returning.
  - wantsPumping
```
public void wantsPumping(PumpedTunnelGateway gw)
```
    Requests pumping for a gateway. Uses a short timeout to avoid blocking the I2CP reader thread when the pumper queue is full.
    Parameters:
    gw - the gateway to pump

Class TunnelGatewayPumper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TunnelGatewayPumper

Method Detail

adjustRunningThreads

adjustThreads

getActiveCount

getInstanceUtilization

getMaxPumpers

getQueueCapacity

getRequeueTime

getUtilization

resizeQueue

resizeRunningQueue

run

setMaxPumpers

setQueueCapacity

setRequeueTime

stopPumping

wantsPumping