Class PumpedTunnelGateway

java.lang.Object
net.i2p.router.tunnel.TunnelGateway
net.i2p.router.tunnel.PumpedTunnelGateway
Direct Known Subclasses:
ThrottledPumpedTunnelGateway

class PumpedTunnelGateway extends TunnelGateway
This is used for all gateways with more than zero hops. Serve as the gatekeeper for a tunnel, accepting messages, coallescing and/or fragmenting them before wrapping them up for tunnel delivery. The flow here is:
  1. add an I2NPMessage (and a target tunnel/router, if necessary)
  2. that message is queued up into a TunnelGateway.Pending and offered to the assigned QueuePreprocessor.
  3. that QueuePreprocessor may then take off any of the TunnelGateway.Pending messages or instruct the TunnelGateway to offer it the messages again in a short while (in an attempt to coallesce them).
  4. when the QueueProcessor accepts a TunnelGateway.Pending, it preprocesses it into fragments, forwarding each preprocessed fragment group through the Sender.
  5. the Sender then encrypts the preprocessed data and delivers it to the Receiver.
  6. the Receiver now has the encrypted message and may do with it as it pleases (e.g. wrap it as necessary and enqueue it onto the OutNetMessagePool, or if debugging, verify that it can be decrypted properly)
  • Constructor Details

  • Method Details

    • add

      public void add(I2NPMessage msg, Hash toRouter, TunnelId toTunnel)
      Add a message to be sent down the tunnel, either sending it now (perhaps coallesced with other pending messages) or after a brief pause (_flushFrequency). If it is queued up past its expiration, it is silently dropped This is only for OBGWs. See TPTG override for IBGWs.
      Overrides:
      add in class TunnelGateway
      Parameters:
      msg - message to be sent through the tunnel
      toRouter - router to send to after the endpoint (or null for endpoint processing)
      toTunnel - tunnel to send to after the endpoint (or null for endpoint or router processing)
    • add

      protected void add(PendingGatewayMessage cur)
    • pump

      public boolean pump(List<PendingGatewayMessage> queueBuf)
      run in one of the TunnelGatewayPumper's threads, this pulls pending messages off the prequeue, adds them to the queue and then tries to preprocess the queue, scheduling a later delayed flush as necessary. this allows the gw.add call to go quickly, rather than blocking its callers on potentially substantial processing.
      Parameters:
      queueBuf - Empty list for convenience, to use as a temporary buffer. Must be empty when called; will always be emptied before return.
      Returns:
      true if we did not finish, and the pumper should be requeued.