net.tomp2p.rpc

Class DispatchHandler

java.lang.Object

net.tomp2p.rpc.DispatchHandler

Direct Known Subclasses:

AnnounceRPC, BroadcastRPC, DirectDataRPC, NeighborRPC, PingRPC, QuitRPC

public abstract class DispatchHandler
extends Object

The dispatcher handlers that can be added to the Dispatcher.

Author:

Thomas Bocek

Constructor Summary

Constructors

Constructor and Description
DispatchHandler(PeerBean peerBean, ConnectionBean connectionBean) Creates a handler with a connection and peer bean.

Method Summary

Methods

Modifier and Type	Method and Description
ConnectionBean	connectionBean()
Message	createMessage(PeerAddress recipient, byte name, Message.Type type) Create a request message and fills it with connection bean and peer bean parameters.
Message	createResponseMessage(Message requestMessage, Message.Type replyType) Create a response message and fills it with connection bean and peer bean parameters.
static Message	createResponseMessage(Message requestMessage, Message.Type replyType, PeerAddress peerAddress)
void	forwardMessage(Message requestMessage, PeerConnection peerConnection, Responder responder) Forwards the request to a handler.
abstract void	handleResponse(Message message, PeerConnection peerConnection, boolean sign, Responder responder) If the message is OK, that has been previously checked by the user using checkMessage, a reply to the message is generated here.
PeerBean	peerBean()
void	register(int... names) Registers all names on the dispatcher on behalf of the own peer
void	register(Number160 onBehalfOf, int... names) Registers all names on the dispatcher on behalf of the given peer
void	sign(boolean sign)

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatchHandler

public DispatchHandler(PeerBean peerBean,
               ConnectionBean connectionBean)

Creates a handler with a connection and peer bean.

Parameters:

peerBean - The peer bean

connectionBean - The connection bean

names - The command names

Method Detail

register

public void register(int... names)

Registers all names on the dispatcher on behalf of the own peer

Parameters:

names -

register

public void register(Number160 onBehalfOf,
            int... names)

Registers all names on the dispatcher on behalf of the given peer

Parameters:

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

names -

sign

public void sign(boolean sign)

Parameters:

sign - Set to true if message is signed

peerBean

public PeerBean peerBean()

Returns:

The peer bean

connectionBean

public ConnectionBean connectionBean()

Returns:

The connection bean

createMessage

public Message createMessage(PeerAddress recipient,
                    byte name,
                    Message.Type type)

Create a request message and fills it with connection bean and peer bean parameters.

Parameters:

recipient - The recipient of this message

name - The commend type

type - The request type

Returns:

The request message

createResponseMessage

public Message createResponseMessage(Message requestMessage,
                            Message.Type replyType)

Create a response message and fills it with connection bean and peer bean parameters.

Parameters:

requestMessage - The request message

replyType - The type of the reply

Returns:

The reply message

createResponseMessage

public static Message createResponseMessage(Message requestMessage,
                            Message.Type replyType,
                            PeerAddress peerAddress)

forwardMessage

public void forwardMessage(Message requestMessage,
                  PeerConnection peerConnection,
                  Responder responder)

Forwards the request to a handler.

Parameters:

requestMessage - The request message

peerConnection - The peer connection that can be used for communication

responder -

handleResponse

public abstract void handleResponse(Message message,
                  PeerConnection peerConnection,
                  boolean sign,
                  Responder responder)
                             throws Exception

If the message is OK, that has been previously checked by the user using checkMessage, a reply to the message is generated here.

Parameters:

message - Request message

peerConnection -

sign - Flag to indicate if message is signed

responder2 -

responder -

Throws:

Exception - Any exception