ThrottledPumpedTunnelGateway

net.i2p.router.tunnel.ThrottledPumpedTunnelGateway

class ThrottledPumpedTunnelGatewayextends PumpedTunnelGateway

Specialized pumped tunnel gateway for inbound gateways (IBGWs) that throttles messages by checking bandwidth usage before queuing them.

This class drops messages early based on bandwidth heuristics to more efficiently preserve network and system resources compared to processing fragments.

The drop decision is made here instead of deeper in the tunnel to allow dropping whole I2NP messages, where message type and size are known accurately.

Thread safety and behavior otherwise follows PumpedTunnelGateway.

Nested Class Summary
Nested classes/interfaces inherited from class TunnelGateway
TunnelGateway.DelayedFlush, TunnelGateway.QueuePreprocessor, TunnelGateway.Receiver, TunnelGateway.Sender
Modifier and Type
Class
Description
protected class
TunnelGateway.DelayedFlush
Delayed flush timer event.
static interface
TunnelGateway.QueuePreprocessor
Interface for preprocessing queued tunnel messages.
static interface
TunnelGateway.Receiver
Interface for receiving encrypted tunnel data.
static interface
TunnelGateway.Sender
Interface for sending preprocessed tunnel data.
Field Summary
Fields
Modifier and Type
Field
Description
private final HopConfig
_config
Configuration and statistics for this hop, used to count dropped messages.
private final SyntheticREDQueue
_partBWE
Synthetic Random Early Drop queue to estimate bandwidth usage and perform drops.
Fields inherited from class PumpedTunnelGateway
_isInbound, PROP_INITIAL_OB_QUEUE, PROP_MAX_IB_MSGS_PER_PUMP, PROP_MAX_IB_QUEUE, PROP_MAX_OB_MSGS_PER_PUMP
Modifier and Type
Field
Description
final boolean
_isInbound
Whether this gateway is inbound (vs outbound).
static final String
PROP_INITIAL_OB_QUEUE
Property key for initial outbound queue size.
static final String
PROP_MAX_IB_MSGS_PER_PUMP
Property key for max inbound messages per pump.
static final String
PROP_MAX_IB_QUEUE
Property key for max inbound queue size.
static final String
PROP_MAX_OB_MSGS_PER_PUMP
Property key for max outbound messages per pump.
Fields inherited from class TunnelGateway
_context, _delayedFlush, _lastFlush, _log, _messagesSent, _preprocessor, _queue, _receiver, _sender
Modifier and Type
Field
Description
protected final RouterContext
_context
The router context.
protected final TunnelGateway.DelayedFlush
_delayedFlush
The delayed flush timer.
protected long
_lastFlush
The last flush time.
protected final Log
_log
The log instance.
protected int
_messagesSent
The messages sent count.
protected final TunnelGateway.QueuePreprocessor
_preprocessor
The queue preprocessor.
protected final List<PendingGatewayMessage>
_queue
The message queue.
protected final TunnelGateway.Receiver
_receiver
The message receiver, consuming encrypted messages for forwarding.
protected final TunnelGateway.Sender
_sender
The message sender, encrypting and forwarding preprocessed messages.
Constructor Summary
Constructors
Constructor
Description
ThrottledPumpedTunnelGateway(RouterContext context, TunnelGateway.QueuePreprocessor preprocessor, TunnelGateway.Sender sender, TunnelGateway.Receiver receiver, TunnelGatewayPumper pumper, HopConfig config)
A pump-driven gateway that drops excess messages based on estimated bandwidth.
Method Summary
All Methods
Modifier and Type
Method
Description
boolean
add(I2NPMessage msg, Hash toRouter, TunnelId toTunnel)
Adds a message to the inbound gateway after a bandwidth-based drop check.
String
toString()
Human-readable description differentiating inbound gateway and including tunnel ID.
Methods inherited from class PumpedTunnelGateway
add, getMaxIbMsgsPerPump, getMaxObMsgsPerPump, pump, setMaxIbMsgsPerPump, setMaxObMsgsPerPump
Modifier and Type
Method
Description
protected boolean
add(PendingGatewayMessage cur)
Adds a PendingGatewayMessage to the prequeue and notifies the pumper to process it.
static int
getMaxIbMsgsPerPump()
The maximum inbound messages per pump.
static int
getMaxObMsgsPerPump()
The cap the pump applies to outbound messages, read once per pump pass so a single busy iteration cannot monopolise the thread.
boolean
pump(List<PendingGatewayMessage> queueBuf)
Pumps messages from the internal prequeue into the processing queue.
static void
setMaxIbMsgsPerPump(int val)
The maximum inbound messages per pump.
static void
setMaxObMsgsPerPump(int val)
The maximum outbound messages per pump.
Methods inherited from class TunnelGateway
add, getMessagesSent
Modifier and Type
Method
Description
boolean
add(TunnelGatewayMessage msg)
Add a message to be sent down the tunnel, where we are the inbound gateway.
int
getMessagesSent()
The number of messages sent.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _config
  private final HopConfig _config
  Configuration and statistics for this hop, used to count dropped messages.
- _partBWE
  private final SyntheticREDQueue _partBWE
  Synthetic Random Early Drop queue to estimate bandwidth usage and perform drops.
Constructor Details
- ThrottledPumpedTunnelGateway
  public ThrottledPumpedTunnelGateway(RouterContext context, TunnelGateway.QueuePreprocessor preprocessor, TunnelGateway.Sender sender, TunnelGateway.Receiver receiver, TunnelGatewayPumper pumper, HopConfig config)
  A pump-driven gateway that drops excess messages based on estimated bandwidth.
  Allocated bandwidth value is retrieved from config or set to reasonable default.
  Parameters:
  context - the router context supplying the bandwidth allocation
  preprocessor - QueuePreprocessor for the gateway
  sender - Encrypting Sender for fragments
  receiver - Receiving entity consuming encrypted messages
  pumper - TunnelGatewayPumper managing pumping threads
  config - HopConfig containing bandwidth and message statistics
Method Details
- add
  public boolean add(I2NPMessage msg, Hash toRouter, TunnelId toTunnel)
  Adds a message to the inbound gateway after a bandwidth-based drop check.
  Drops messages early based on estimated size and bandwidth usage, tracking statistics.
  We do this here instead of in the InboundGatewayReceiver because it is much smarter to drop whole I2NP messages, where we know the message type and length, rather than tunnel messages containing I2NP fragments.
  Hard to do this exactly, but we'll assume 2:1 batching for the purpose of estimating outgoing size. We assume that it's the outbound bandwidth that is the issue...
  Overrides:
  add in class PumpedTunnelGateway
  Parameters:
  msg - the I2NP message to add
  toRouter - optional target router after the endpoint
  toTunnel - optional target tunnel after the endpoint
  Returns:
  true if the message was accepted, false if dropped for bandwidth or queue full
- toString
  public String toString()
  Human-readable description differentiating inbound gateway and including tunnel ID.
  Overrides:
  toString in class Object
  Returns:
  String description of this inbound pumped tunnel gateway

Nested Class Summary

Nested classes/interfaces inherited from class TunnelGateway

Field Summary

Fields inherited from class PumpedTunnelGateway

Fields inherited from class TunnelGateway

Constructor Summary

Method Summary

Methods inherited from class PumpedTunnelGateway

Methods inherited from class TunnelGateway

Methods inherited from class Object

Field Details

_config

_partBWE

Constructor Details

ThrottledPumpedTunnelGateway

Method Details

add

toString