InNetMessagePool (I2P Anonymous Network - Java Documentation

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

All Implemented Interfaces:

Service
```
public class InNetMessagePool
extends Object
implements Service
```
Manage a pool of inbound InNetMessages. This pool is filled by the Network communication system when it receives messages, and various jobs periodically retrieve them for processing. Actually, this doesn't 'pool' anything, since DISPATCH_DIRECT = true.

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`DEFAULT_DISPATCH_THREADED`
`static String`	`PROP_DISPATCH_THREADED`	If set to true, we will have two additional threads - one for dispatching tunnel data messages, and another for dispatching tunnel gateway messages.

Constructor Summary

Constructors
Constructor Description

InNetMessagePool(RouterContext context)

Constructors
Constructor	Description
`InNetMessagePool(RouterContext context)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`int`	`add(I2NPMessage messageBody, RouterIdentity fromRouter, Hash fromRouterHash)`	Add a new message to the pool.
`int`	`handleReplies(I2NPMessage messageBody)`
`HandlerJobBuilder`	`registerHandlerJobBuilder(int i2npMessageType, HandlerJobBuilder builder)`
`void`	`renderStatusHTML(Writer out)`
`void`	`restart()`	does nothing since we aren't threaded
`void`	`shutdown()`	does nothing since we aren't threaded
`void`	`startup()`	does nothing since we aren't threaded
`HandlerJobBuilder`	`unregisterHandlerJobBuilder(int i2npMessageType)`	Deprecated. unused

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

- Field Detail
  - PROP_DISPATCH_THREADED
```
public static final String PROP_DISPATCH_THREADED
```
    If set to true, we will have two additional threads - one for dispatching tunnel data messages, and another for dispatching tunnel gateway messages. These will not use the JobQueue but will operate sequentially. Otherwise, if this is set to false, the messages will be queued up in the jobQueue, using the jobQueue's single thread.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DISPATCH_THREADED
```
public static final boolean DEFAULT_DISPATCH_THREADED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - InNetMessagePool
```
public InNetMessagePool(RouterContext context)
```
- Method Detail
  - registerHandlerJobBuilder
```
public HandlerJobBuilder registerHandlerJobBuilder(int i2npMessageType,
                                                   HandlerJobBuilder builder)
```
    Returns:
    
    previous builder for this message type, or null
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if i2npMessageType is greater than MAX_I2NP_MESSAGE_TYPE
  - unregisterHandlerJobBuilder
```
@Deprecated
public HandlerJobBuilder unregisterHandlerJobBuilder(int i2npMessageType)
```
    Deprecated.
    unused
    
    Returns:
    
    previous builder for this message type, or null
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if i2npMessageType is greater than MAX_I2NP_MESSAGE_TYPE
  - add
```
public int add(I2NPMessage messageBody,
               RouterIdentity fromRouter,
               Hash fromRouterHash)
```
    Add a new message to the pool. If there is a HandlerJobBuilder for the inbound message type, the message is loaded into a job created by that builder and queued up for processing instead (though if the builder doesn't create a job, it is added to the pool)
    
    Parameters:
    
    messageBody - non-null
    
    fromRouter - may be null
    
    fromRouterHash - may be null, calculated from fromRouter if null
    
    Returns:
    
    -1 for some types of errors but not all; 0 otherwise (was queue length, long ago)
  - handleReplies
```
public int handleReplies(I2NPMessage messageBody)
```
  - renderStatusHTML
```
public void renderStatusHTML(Writer out)
```
    Specified by:
    
    renderStatusHTML in interface Service
  - restart
```
public void restart()
```
    does nothing since we aren't threaded
    
    Specified by:
    
    restart in interface Service
  - shutdown
```
public void shutdown()
```
    does nothing since we aren't threaded
    
    Specified by:
    
    shutdown in interface Service
  - startup
```
public void startup()
```
    does nothing since we aren't threaded
    
    Specified by:
    
    startup in interface Service

Class InNetMessagePool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_DISPATCH_THREADED

DEFAULT_DISPATCH_THREADED

Constructor Detail

InNetMessagePool

Method Detail

registerHandlerJobBuilder

unregisterHandlerJobBuilder

add

handleReplies

renderStatusHTML

restart

shutdown

startup