net.i2p.router

Class InNetMessagePool

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.

Constructor Summary

Constructors

Constructor and Description
InNetMessagePool(RouterContext context)

Method Summary

Modifier and Type	Method and Description
int	add(I2NPMessage messageBody, RouterIdentity fromRouter, net.i2p.data.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

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,
               net.i2p.data.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