TunnelGatewayPumper.PoisonPTG

net.i2p.router.tunnel.TunnelGatewayPumper.PoisonPTG

Enclosing class:: TunnelGatewayPumper

private static class TunnelGatewayPumper.PoisonPTGextends PumpedTunnelGateway

Special poison pill PumpedTunnelGateway to signal thread shutdown.

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
private static class
TunnelGatewayPumper.PoisonPTG.NoOpReceiver
No-op receiver for poison pill to avoid null pointer issues.
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 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
PoisonPTG(RouterContext ctx)
Builds the gateway that stops a pump thread.
Method Summary
All Methods
Modifier and Type
Method
Description
int
getMessagesSent()
The number of messages sent.
boolean
pump(List<PendingGatewayMessage> queueBuf)
Pumps messages from the internal prequeue into the processing queue.
Methods inherited from class PumpedTunnelGateway
add, add, getMaxIbMsgsPerPump, getMaxObMsgsPerPump, setMaxIbMsgsPerPump, setMaxObMsgsPerPump
Modifier and Type
Method
Description
boolean
add(I2NPMessage msg, Hash toRouter, TunnelId toTunnel)
Adds a message to be sent down the tunnel.
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.
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
Modifier and Type
Method
Description
boolean
add(TunnelGatewayMessage msg)
Add a message to be sent down the tunnel, where we are the inbound gateway.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- PoisonPTG
  public PoisonPTG(RouterContext ctx)
  Builds the gateway that stops a pump thread.
  Parameters:
  ctx - the router context
Method Details
- getMessagesSent
  public int getMessagesSent()
  Description copied from class: TunnelGateway
  The number of messages sent.
  Overrides:
  getMessagesSent in class TunnelGateway
  Returns:
  the number of messages sent
- pump
  public boolean pump(List<PendingGatewayMessage> queueBuf)
  Description copied from class: PumpedTunnelGateway
  Pumps messages from the internal prequeue into the processing queue.
  This method tries to drain a bounded number of messages from _prequeue into the provided queueBuf, then adds them to the internal _queue for preprocessing and fragmentation.
  Expired messages are removed after preprocessing, outside the synchronization block, to reduce contention.
  Overrides:
  pump in class PumpedTunnelGateway
  Parameters:
  queueBuf - an empty list used as a temporary buffer for messages (will be cleared before return)
  Returns:
  true if there are still messages remaining in _prequeue and the caller should requeue this 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

Constructor Details

PoisonPTG

Method Details

getMessagesSent

pump