net.tomp2p.rpc

Class NeighborRPC

java.lang.Object

net.tomp2p.rpc.DispatchHandler

net.tomp2p.rpc.NeighborRPC

public class NeighborRPC
extends DispatchHandler

Handles the neighbor requests and replies.

Author:

Thomas Bocek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NeighborRPC.SearchValues The search values for fast get.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NEIGHBOR_LIMIT
static int	NEIGHBOR_SIZE

Constructor Summary

Constructors

Constructor and Description
NeighborRPC(PeerBean peerBean, ConnectionBean connectionBean)
NeighborRPC(PeerBean peerBean, ConnectionBean connectionBean, boolean register) Setup the RPC and register for incoming messages.

Method Summary

Methods

Modifier and Type	Method and Description
FutureResponse	closeNeighbors(PeerAddress remotePeer, NeighborRPC.SearchValues searchValues, Message.Type type, ChannelCreator channelCreator, ConnectionConfiguration configuration) Requests close neighbors from the remote peer.
protected Collection<PeerAddress>	getNeighbors(Number160 id, int atLeast) TODO: explain why protected method here.
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.

Methods inherited from class net.tomp2p.rpc.DispatchHandler

connectionBean, createMessage, createResponseMessage, createResponseMessage, forwardMessage, peerBean, register, register, sign

Methods inherited from class java.lang.Object

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

Field Detail

NEIGHBOR_SIZE

public static final int NEIGHBOR_SIZE

See Also:

Constant Field Values

NEIGHBOR_LIMIT

public static final int NEIGHBOR_LIMIT

See Also:

Constant Field Values

Constructor Detail

NeighborRPC

public NeighborRPC(PeerBean peerBean,
           ConnectionBean connectionBean)

NeighborRPC

public NeighborRPC(PeerBean peerBean,
           ConnectionBean connectionBean,
           boolean register)

Setup the RPC and register for incoming messages.

Parameters:

peerBean - The peer bean

connectionBean - The connection bean

Method Detail

closeNeighbors

public FutureResponse closeNeighbors(PeerAddress remotePeer,
                            NeighborRPC.SearchValues searchValues,
                            Message.Type type,
                            ChannelCreator channelCreator,
                            ConnectionConfiguration configuration)

Requests close neighbors from the remote peer. The remote peer may idicate if the data is present on that peer. This is an RPC.

Parameters:

remotePeer - The remote peer to send this request

searchValues - The values to search for in the storage

type - The type of the neighbor request:

• REQUEST_1 for NEIGHBORS means check for put (no digest) for tracker and storage
• REQUEST_2 for NEIGHBORS means check for get (with digest) for storage
• REQUEST_3 for NEIGHBORS means check for get (with digest) for tracker
• REQUEST_4 for NEIGHBORS means check for put (with digest) for task

channelCreator - The channel creator that creates connections

configuration - The client side connection configuration

Returns:

The future response to keep track of future events

handleResponse

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

Description copied from class: DispatchHandler

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

Specified by:

handleResponse in class DispatchHandler

Parameters:

message - Request message

sign - Flag to indicate if message is signed

Throws:

IOException

getNeighbors

protected Collection<PeerAddress> getNeighbors(Number160 id,
                                   int atLeast)

TODO: explain why protected method here.