net.tomp2p.connection

Class Dispatcher

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<Message>

net.tomp2p.connection.Dispatcher

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

@ChannelHandler.Sharable
public class Dispatcher
extends io.netty.channel.SimpleChannelInboundHandler<Message>

Used to deliver incoming REQUEST messages to their specific handlers. You can register handlers using the registerIoHandler function.

You probably want to add an instance of this class to the end of a pipeline to be able to receive messages. This class is able to cover several channels but only one P2P network!

Author:

Thomas Bocek

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
Dispatcher(int p2pID, PeerBean peerBeanMaster, int heartBeatMillis)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPendingRequest(int messageId, FutureResponse futureResponse, int timeout, ScheduledExecutorService scheduler) Add a new pending request.
DispatchHandler	associatedHandler(Message message) Checks if we have a handler for the given message.
protected void	channelRead0(io.netty.channel.ChannelHandlerContext ctx, Message message)
Map<Integer,FutureResponse>	getPendingRequests()
PeerBean	peerBean()
void	registerIoHandler(Number160 peerId, Number160 onBehalfOf, DispatchHandler ioHandler, int... names) Registers a handler with this dispatcher.
void	removeIoHandler(Number160 peerId, Number160 onBehalfOf) If we shutdown, we remove the handlers.
Map<Number320,DispatchHandler>	searchHandler(Integer command) May take longer..
DispatchHandler	searchHandler(Number160 recipientID, Number160 onBehalfOf, int cmd) Looks for a registered handler according to the given parameters.
Map<Integer,DispatchHandler>	searchHandlerMap(Number160 peerId, Number160 onBehalfOf)

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

Dispatcher

public Dispatcher(int p2pID,
          PeerBean peerBeanMaster,
          int heartBeatMillis)

Parameters:

p2pID - the p2p ID the dispatcher is looking for in messages

peerBeanMaster -

heartBeatMillis -

Method Detail

peerBean

public PeerBean peerBean()

registerIoHandler

public void registerIoHandler(Number160 peerId,
                     Number160 onBehalfOf,
                     DispatchHandler ioHandler,
                     int... names)

Registers a handler with this dispatcher. Future received messages adhering to the given parameters will be forwarded to that handler. Note that the dispatcher only handles REQUEST messages. This method is thread-safe, and uses copy on write as its expected to run this only during initialization.

Parameters:

peerId - Specifies the receiver the dispatcher filters for. This allows to use one dispatcher for several interfaces or even nodes.

onBehalfOf - The ioHandler can be registered for the own use of in behalf of another peer (e.g. in case of relay node).

ioHandler - the handler which should process the given type of messages

names - The command of the Message the given handler processes. All messages having that command will be forwarded to the given handler.
Note: If you register multiple handlers with the same command, only the last registered handler will receive these messages!

removeIoHandler

public void removeIoHandler(Number160 peerId,
                   Number160 onBehalfOf)

If we shutdown, we remove the handlers. This means that a server may respond that the handler is unknown.

Parameters:

peerId - The Id of the peer to remove the handlers .

onBehalfOf - The ioHandler can be registered for the own use of in behalf of another peer (e.g. in case of relay node).

channelRead0

protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
                Message message)
                     throws Exception

Specified by:

channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<Message>

Throws:

Exception

associatedHandler

public DispatchHandler associatedHandler(Message message)

Checks if we have a handler for the given message.

Parameters:

message - the message a handler should be found for

Returns:

the handler for the given message, null if none has been registered for that message.

searchHandler

public DispatchHandler searchHandler(Number160 recipientID,
                            Number160 onBehalfOf,
                            int cmd)

Looks for a registered handler according to the given parameters.

Parameters:

recipientID - The recipient of the message

onBehalfOf - The ioHandler can be registered for the own use of in behalf of another peer (e.g. in case of relay node).

cmd - The type of the message to be filtered

Returns:

the handler for the given message or null if none has been found

searchHandler

public Map<Number320,DispatchHandler> searchHandler(Integer command)

May take longer.. used for testing

Parameters:

command -

Returns:

searchHandlerMap

public Map<Integer,DispatchHandler> searchHandlerMap(Number160 peerId,
                                            Number160 onBehalfOf)

Parameters:

peerId - The id of the peer the get the dispatcher map

onBehalfOf - The ioHandler can be registered for the own use of in behalf of another peer (e.g. in case of relay node).

Returns:

the map containing all dispatchers for each RPC.Commands type

addPendingRequest

public void addPendingRequest(int messageId,
                     FutureResponse futureResponse,
                     int timeout,
                     ScheduledExecutorService scheduler)

Add a new pending request. If slow peers answer, this map will be checked for an entry

Parameters:

messageId - the message id

futureResponse - the future to respond as soon as a (satisfying) response from the slow peer arrived.

scheduler -

timeout -

getPendingRequests

public Map<Integer,FutureResponse> getPendingRequests()

Returns:

all pending requests