RouterThrottleImpl (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.RouterThrottleImpl

All Implemented Interfaces:
RouterThrottle
```
public class RouterThrottleImpl
extends Object
implements RouterThrottle
```
Simple throttle that basically stops accepting messages or nontrivial requests if the jobQueue lag is too large.

Field Summary

Fields
Modifier and Type	Field and Description
`protected RouterContext`	`_context`
`static int`	`DEFAULT_MESSAGES_PER_TUNNEL_ESTIMATE` This is the estimated number of 1 KB tunnel messages that we'll see in 10 minute lifetime of an exploratory tunnel.
`static int`	`defaultMaxTunnels` Default maximum tunnels, adjusted by system speed and memory.
`static String`	`PROP_MAX_TUNNELS`
`static int`	`TUNNEL_ACCEPT` Tunnel acceptance

Constructor Summary
Constructors
Constructor and Description
RouterThrottleImpl(RouterContext context)

Constructors
Constructor and Description
`RouterThrottleImpl(RouterContext context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptNetworkMessage()` Should we accept any more data from the network for any sort of message, taking into account our current load, or should we simply slow down? FIXME only called by SSU Receiver, not NTCP! FIXME should put warning on the console FIXME or should we do this at all? We have Codel queues all over now...
`int`	`acceptTunnelRequest()` If we should send a reject, return a nonzero reject code.
`void`	`cancelShutdownStatus()`
`static int`	`getDefaultMaxTunnels()`
`String`	`getLocalizedTunnelStatus()` The current tunnel status, translated if available.
`long`	`getMessageDelay()` The average message processing delay.
`static int`	`getMinBandwidthFloorPerTunnel(RouterContext ctx)` Calculate a floor for per-tunnel bandwidth allocation based on participating tunnel count and total outbound bandwidth share.
`long`	`getTunnelLag()` The current tunnel lag.
`String`	`getTunnelStatus()` The current tunnel status message.
`static boolean`	`isShuttingDown(RouterContext context)` Whether the router is shutting down.
`static void`	`setDefaultMaxTunnels(int val)`
`void`	`setShutdownStatus()`
`void`	`setTunnelStatus(String msg)` The tunnel acceptance status message.

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

- Field Detail
  - _context
```
protected final RouterContext _context
```
  - DEFAULT_MESSAGES_PER_TUNNEL_ESTIMATE
```
public static final int DEFAULT_MESSAGES_PER_TUNNEL_ESTIMATE
```
    This is the estimated number of 1 KB tunnel messages that we'll see in 10 minute lifetime of an exploratory tunnel. We use it as a baseline minimum for estimating tunnel bandwidth, if accepted. 600 KB in 10 minutes equals ~4 KBps - increased from 200 for better bandwidth allocation per transit tunnel.
    See Also:
    Constant Field Values
  - defaultMaxTunnels
```
public static volatile int defaultMaxTunnels
```
    Default maximum tunnels, adjusted by system speed and memory.
  - PROP_MAX_TUNNELS
```
public static final String PROP_MAX_TUNNELS
```
    See Also:
    Constant Field Values
  - TUNNEL_ACCEPT
```
public static final int TUNNEL_ACCEPT
```
    Tunnel acceptance
    See Also:
    Constant Field Values
- Constructor Detail
  - RouterThrottleImpl
```
public RouterThrottleImpl(RouterContext context)
```
- Method Detail
  - acceptNetworkMessage
```
public boolean acceptNetworkMessage()
```
    Should we accept any more data from the network for any sort of message, taking into account our current load, or should we simply slow down? FIXME only called by SSU Receiver, not NTCP! FIXME should put warning on the console FIXME or should we do this at all? We have Codel queues all over now...
    Specified by:
    acceptNetworkMessage in interface RouterThrottle
  - acceptTunnelRequest
```
public int acceptTunnelRequest()
```
    If we should send a reject, return a nonzero reject code. Anything that causes us to drop a request instead of rejecting it must go in BuildHandler.handleInboundRequest(), not here.
    Specified by:
    acceptTunnelRequest in interface RouterThrottle
    Returns:
    0 for accept or nonzero reject code
  - cancelShutdownStatus
```
public void cancelShutdownStatus()
```
    Specified by:
    cancelShutdownStatus in interface RouterThrottle
  - getDefaultMaxTunnels
```
public static int getDefaultMaxTunnels()
```
  - getLocalizedTunnelStatus
```
public String getLocalizedTunnelStatus()
```
    The current tunnel status, translated if available.
    Specified by:
    getLocalizedTunnelStatus in interface RouterThrottle
    Returns:
    the localized tunnel status
  - getMessageDelay
```
public long getMessageDelay()
```
    The average message processing delay.
    Specified by:
    getMessageDelay in interface RouterThrottle
    Returns:
    the message delay
  - getMinBandwidthFloorPerTunnel
```
public static int getMinBandwidthFloorPerTunnel(RouterContext ctx)
```
    Calculate a floor for per-tunnel bandwidth allocation based on participating tunnel count and total outbound bandwidth share. This ensures a minimum allocation even when many tunnels are hosted.
    Returns:
    minimum bytes per second to allocate per tunnel
  - getTunnelLag
```
public long getTunnelLag()
```
    The current tunnel lag.
    Specified by:
    getTunnelLag in interface RouterThrottle
    Returns:
    the tunnel lag
  - getTunnelStatus
```
public String getTunnelStatus()
```
    The current tunnel status message.
    Specified by:
    getTunnelStatus in interface RouterThrottle
    Returns:
    the tunnel status
  - isShuttingDown
```
public static boolean isShuttingDown(RouterContext context)
```
    Whether the router is shutting down.
    Parameters:
    context - the router context
    Returns:
    whether shutting down
  - setDefaultMaxTunnels
```
public static void setDefaultMaxTunnels(int val)
```
  - setShutdownStatus
```
public void setShutdownStatus()
```
    Specified by:
    setShutdownStatus in interface RouterThrottle
  - setTunnelStatus
```
public void setTunnelStatus(String msg)
```
    The tunnel acceptance status message.
    Specified by:
    setTunnelStatus in interface RouterThrottle
    Parameters:
    msg - the status message

Class RouterThrottleImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_context

DEFAULT_MESSAGES_PER_TUNNEL_ESTIMATE

defaultMaxTunnels

PROP_MAX_TUNNELS

TUNNEL_ACCEPT

Constructor Detail

RouterThrottleImpl

Method Detail

acceptNetworkMessage

acceptTunnelRequest

cancelShutdownStatus

getDefaultMaxTunnels

getLocalizedTunnelStatus

getMessageDelay

getMinBandwidthFloorPerTunnel

getTunnelLag

getTunnelStatus

isShuttingDown

setDefaultMaxTunnels

setShutdownStatus

setTunnelStatus