BatchedRouterPreprocessor

net.i2p.router.tunnel.BatchedRouterPreprocessor

All Implemented Interfaces:: TunnelGateway.QueuePreprocessor

class BatchedRouterPreprocessorextends BatchedPreprocessor

Honor the 'batchFrequency' tunnel pool setting or the 'router.batchFrequency' router config setting, and track fragmentation.

Field Summary
Modifier and Type
Field
Description
private final TunnelCreatorConfig
_config
The tunnel the batch is built for.
protected final HopConfig
_hopConfig
The hop config for inbound gateways.
private final long
_sendDelay
Delay before the first batch is sent, in ms.
static final int
DEFAULT_BATCH_FREQUENCY
For IBGWs for efficiency (not our data).
static final int
OB_CLIENT_BATCH_FREQ
For client OBGWs only (our data).
static final int
OB_EXPL_BATCH_FREQ
For exploratory OBGWs only (our tunnel tests and build messages).
static final String
PROP_BATCH_FREQUENCY
How frequently should we flush non-full messages, in milliseconds This goes in I2CP custom options for the pool.
static final String
PROP_ROUTER_BATCH_FREQUENCY
This goes in router advanced config.
Fields inherited from class BatchedPreprocessor
DEFAULT_DELAY, MIN_FLUSH_DELAY
Modifier and Type
Field
Description
(package private) static long
DEFAULT_DELAY
Not final or private so the test code can adjust.
(package private) static final long
MIN_FLUSH_DELAY
Minimum delay even under full pressure (ms) -- avoids busy-wait retry storms.
Fields inherited from class TrivialPreprocessor
_context, _dataCache, _log, IV_SIZE, PREPROCESSED_SIZE
Modifier and Type
Field
Description
protected final RouterContext
_context
The router context.
protected static final ByteCache
_dataCache
Here in tunnels, we take from the cache but never add to it.
protected final Log
_log
The logger.
protected static final int
IV_SIZE
Length of the IV.
static final int
PREPROCESSED_SIZE
Size of preprocessed data blocks.
Constructor Summary
Constructors
Constructor
Description
BatchedRouterPreprocessor(RouterContext ctx, HopConfig cfg)
Create a preprocessor for inbound gateway tunnels.
BatchedRouterPreprocessor(RouterContext ctx, TunnelCreatorConfig cfg)
Create a preprocessor for outbound gateway tunnels.
Method Summary
Modifier and Type
Method
Description
private static String
getName(HopConfig cfg)
Names a hop for the log.
private static String
getName(TunnelCreatorConfig cfg)
Names a tunnel for the log.
protected long
getSendDelay()
How long we should wait before flushing a batch.
private long
initialSendDelay()
Chooses the delay before the first batch is sent, extending the batching time for exploratory OBGWs: they carry many small tunnel test messages and build messages that don't fit perfectly, and those are not as delay-sensitive.
protected void
notePreprocessing(long messageId, int numFragments, int totalLength, List<Long> messageIds, String msg)
Note preprocessing statistics.
Methods inherited from class BatchedPreprocessor
getDelayAmount, preprocessQueue, send
Modifier and Type
Method
Description
long
getDelayAmount()
How long to wait before flushing a queued message.
boolean
preprocessQueue(List<PendingGatewayMessage> pending, TunnelGateway.Sender sender, TunnelGateway.Receiver rec)
Return true if there were messages remaining, and we should queue up a delayed flush to clear them
protected void
send(List<PendingGatewayMessage> pending, int startAt, int sendThrough, TunnelGateway.Sender sender, TunnelGateway.Receiver rec)
Preprocess the messages from the pending list, grouping items startAt through sendThrough (though only part of the last one may be fully sent), delivering them through the sender/receiver.
Methods inherited from class TrivialPreprocessor
getInstructionAugmentationSize, getInstructionsSize, preprocess, writeFirstFragment, writeSubsequentFragment
Modifier and Type
Method
Description
protected static int
getInstructionAugmentationSize(PendingGatewayMessage msg, int offset, int instructionsSize)
Get the augmentation size for instructions if fragmentation is needed.
protected static int
getInstructionsSize(PendingGatewayMessage msg)
Calculate the size of the instructions for a pending message.
protected void
preprocess(byte[] fragments, int fragmentLength)
Wrap the preprocessed fragments with the necessary padding / checksums to act as a tunnel message.
protected int
writeFirstFragment(PendingGatewayMessage msg, byte[] target, int offset)
Write the first fragment of a tunnel message.
protected int
writeSubsequentFragment(PendingGatewayMessage msg, byte[] target, int offset)
Write a subsequent fragment of a tunnel message.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _config
  private final TunnelCreatorConfig _config
  The tunnel the batch is built for.
- _hopConfig
  protected final HopConfig _hopConfig
  The hop config for inbound gateways.
- _sendDelay
  private final long _sendDelay
  Delay before the first batch is sent, in ms.
- PROP_BATCH_FREQUENCY
  public static final String PROP_BATCH_FREQUENCY
  How frequently should we flush non-full messages, in milliseconds This goes in I2CP custom options for the pool. Only applies to OBGWs.
  See Also:
  Constant Field Values
- PROP_ROUTER_BATCH_FREQUENCY
  public static final String PROP_ROUTER_BATCH_FREQUENCY
  This goes in router advanced config.
  See Also:
  Constant Field Values
- OB_CLIENT_BATCH_FREQ
  public static final int OB_CLIENT_BATCH_FREQ
  For client OBGWs only (our data).
- OB_EXPL_BATCH_FREQ
  public static final int OB_EXPL_BATCH_FREQ
  For exploratory OBGWs only (our tunnel tests and build messages).
- DEFAULT_BATCH_FREQUENCY
  public static final int DEFAULT_BATCH_FREQUENCY
  For IBGWs for efficiency (not our data).
Constructor Details
- BatchedRouterPreprocessor
  public BatchedRouterPreprocessor(RouterContext ctx, TunnelCreatorConfig cfg)
  Create a preprocessor for outbound gateway tunnels.
  Parameters:
  ctx - the router context
  cfg - the tunnel creator config
- BatchedRouterPreprocessor
  public BatchedRouterPreprocessor(RouterContext ctx, HopConfig cfg)
  Create a preprocessor for inbound gateway tunnels.
  Parameters:
  ctx - the router context
  cfg - the hop config
Method Details
- getName
  private static String getName(HopConfig cfg)
  Names a hop for the log.
  Parameters:
  cfg - the hop's configuration
  Returns:
  the name to show
- getName
  private static String getName(TunnelCreatorConfig cfg)
  Names a tunnel for the log.
  Parameters:
  cfg - the tunnel's configuration
  Returns:
  the name to show
- getSendDelay
  protected long getSendDelay()
  How long we should wait before flushing a batch.
  Overrides:
  getSendDelay in class BatchedPreprocessor
  Returns:
  the send delay, in ms
- initialSendDelay
  private long initialSendDelay()
  Chooses the delay before the first batch is sent, extending the batching time for exploratory OBGWs: they carry many small tunnel test messages and build messages that don't fit perfectly, and those are not as delay-sensitive. Config changes are not picked up after the preprocessor is created, but a preprocessor's lifetime is only 10 minutes, so just wait.
  Returns:
  the delay, in ms
- notePreprocessing
  protected void notePreprocessing(long messageId, int numFragments, int totalLength, List<Long> messageIds, String msg)
  Description copied from class: TrivialPreprocessor
  Note preprocessing statistics. No-op - intentionally empty.
  Overrides:
  notePreprocessing in class TrivialPreprocessor
  Parameters:
  messageId - the message this fragment carries data for
  numFragments - the fragment number within that message
  totalLength - the total length of the message the fragment belongs to
  messageIds - the message ids of everything coalesced into this fragment
  msg - a description of the flush event, for debugging output

Field Summary

Fields inherited from class BatchedPreprocessor

Fields inherited from class TrivialPreprocessor

Constructor Summary

Method Summary

Methods inherited from class BatchedPreprocessor

Methods inherited from class TrivialPreprocessor

Methods inherited from class Object

Field Details

_config

_hopConfig

_sendDelay

PROP_BATCH_FREQUENCY

PROP_ROUTER_BATCH_FREQUENCY

OB_CLIENT_BATCH_FREQ

OB_EXPL_BATCH_FREQ

DEFAULT_BATCH_FREQUENCY

Constructor Details

BatchedRouterPreprocessor

Method Details

getName

getName

getSendDelay

initialSendDelay

notePreprocessing