net.tomp2p.rpc

Class PingRPC

java.lang.Object

net.tomp2p.rpc.DispatchHandler

net.tomp2p.rpc.PingRPC

public class PingRPC
extends DispatchHandler

The Ping message handler. Also used for NAT detection and other things.

Author:

Thomas Bocek

Field Summary

Fields

Modifier and Type	Field and Description
static int	WAIT_TIME

Constructor Summary

Constructors

Constructor and Description
PingRPC(PeerBean peerBean, ConnectionBean connectionBean) Creates an new handshake RPC with listeners.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPeerReachableListener(PeerReachable peerReachable)
void	addPeerReceivedBroadcastPingListener(PeerReceivedBroadcastPing peerReceivedBroadcastPing)
FutureResponse	fireTCP(PeerAddress remotePeer, ChannelCreator channelCreator, ConnectionConfiguration configuration) Ping a TCP peer, but don't expect an answer.
FutureResponse	fireUDP(PeerAddress remotePeer, ChannelCreator channelCreator, ConnectionConfiguration configuration) Ping a UDP peer, but don't expect an answer.
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.
RequestHandler<FutureResponse>	ping(PeerAddress remotePeer, ConnectionConfiguration configuration) Ping with UDP or TCP, but do not send yet.
FutureResponse	pingBroadcastUDP(PeerAddress remotePeer, ChannelCreator channelCreator, ConnectionConfiguration configuration) Ping a UDP peer using layer 2 broadcast.
FutureResponse	pingTCP(PeerAddress remotePeer, ChannelCreator channelCreator, ConnectionConfiguration configuration) Ping a TCP peer.
FutureResponse	pingTCPDiscover(PeerAddress remotePeer, ChannelCreator channelCreator, ConnectionConfiguration configuration) Ping a TCP peer, and find out how the other peer sees us.
FutureResponse	pingTCPProbe(PeerAddress remotePeer, ChannelCreator channelCreator, ConnectionConfiguration configuration) Ping a TCP peer, and request the other peer to ping us on our public address with a fire and forget message.
FutureResponse	pingUDP(PeerAddress remotePeer, ChannelCreator channelCreator, ConnectionConfiguration configuration) Ping a UDP peer.
FutureResponse	pingUDPDiscover(PeerAddress remotePeer, ChannelCreator channelCreator, ConnectionConfiguration configuration) Ping a UDP peer, and find out how the other peer sees us.
FutureResponse	pingUDPProbe(PeerAddress remotePeer, ChannelCreator channelCreator, ConnectionConfiguration configuration) Ping a UDP peer, and request the other peer to ping us on our public address with a fire and forget message.
void	removePeerReachableListener(PeerReachable peerReachable)
void	removePeerReceivedBroadcastPingListener(PeerReceivedBroadcastPing peerReceivedBroadcastPing)

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

WAIT_TIME

public static final int WAIT_TIME

See Also:

Constant Field Values

Constructor Detail

PingRPC

public PingRPC(PeerBean peerBean,
       ConnectionBean connectionBean)

Creates an new handshake RPC with listeners.

Parameters:

peerBean - The peer bean

connectionBean - The connection bean

Method Detail

ping

public RequestHandler<FutureResponse> ping(PeerAddress remotePeer,
                                  ConnectionConfiguration configuration)

Ping with UDP or TCP, but do not send yet.

Parameters:

remotePeer - The destination peer

Returns:

the request handler, where we can call sendUDP(), or sendTCP()

pingUDP

public FutureResponse pingUDP(PeerAddress remotePeer,
                     ChannelCreator channelCreator,
                     ConnectionConfiguration configuration)

Ping a UDP peer.

Parameters:

remotePeer - The destination peer

channelCreator - The channel creator where we create a UPD channel

Returns:

The future that will be triggered when we receive an answer or something fails.

pingBroadcastUDP

public FutureResponse pingBroadcastUDP(PeerAddress remotePeer,
                              ChannelCreator channelCreator,
                              ConnectionConfiguration configuration)

Ping a UDP peer using layer 2 broadcast.

Parameters:

remotePeer - The destination peer

channelCreator - The channel creator where we create a UPD channel

Returns:

The future that will be triggered when we receive an answer or something fails.

pingTCP

public FutureResponse pingTCP(PeerAddress remotePeer,
                     ChannelCreator channelCreator,
                     ConnectionConfiguration configuration)

Ping a TCP peer.

Parameters:

remotePeer - The destination peer

channelCreator - The channel creator where we create a UPD channel

Returns:

The future that will be triggered when we receive an answer or something fails.

fireUDP

public FutureResponse fireUDP(PeerAddress remotePeer,
                     ChannelCreator channelCreator,
                     ConnectionConfiguration configuration)

Ping a UDP peer, but don't expect an answer.

Parameters:

remotePeer - The destination peer

channelCreator - The channel creator where we create a UPD channel

Returns:

The future that will be triggered when we receive an answer or something fails.

fireTCP

public FutureResponse fireTCP(PeerAddress remotePeer,
                     ChannelCreator channelCreator,
                     ConnectionConfiguration configuration)

Ping a TCP peer, but don't expect an answer.

Parameters:

remotePeer - The destination peer

channelCreator - The channel creator where we create a UPD channel

Returns:

The future that will be triggered when we receive an answer or something fails.

pingUDPDiscover

public FutureResponse pingUDPDiscover(PeerAddress remotePeer,
                             ChannelCreator channelCreator,
                             ConnectionConfiguration configuration)

Ping a UDP peer, and find out how the other peer sees us.

Parameters:

remotePeer - The destination peer

channelCreator - The channel creator where we create a UPD channel

Returns:

The future that will be triggered when we receive an answer or something fails.

pingTCPDiscover

public FutureResponse pingTCPDiscover(PeerAddress remotePeer,
                             ChannelCreator channelCreator,
                             ConnectionConfiguration configuration)

Ping a TCP peer, and find out how the other peer sees us.

Parameters:

remotePeer - The destination peer

channelCreator - The channel creator where we create a UPD channel

Returns:

The future that will be triggered when we receive an answer or something fails.

pingUDPProbe

public FutureResponse pingUDPProbe(PeerAddress remotePeer,
                          ChannelCreator channelCreator,
                          ConnectionConfiguration configuration)

Ping a UDP peer, and request the other peer to ping us on our public address with a fire and forget message.

Parameters:

remotePeer - The destination peer

channelCreator - The channel creator where we create a UPD channel

Returns:

The future that will be triggered when we receive an answer or something fails.

pingTCPProbe

public FutureResponse pingTCPProbe(PeerAddress remotePeer,
                          ChannelCreator channelCreator,
                          ConnectionConfiguration configuration)

Ping a TCP peer, and request the other peer to ping us on our public address with a fire and forget message.

Parameters:

remotePeer - The destination peer

channelCreator - The channel creator where we create a UPD channel

Returns:

The future that will be triggered when we receive an answer or something fails.

handleResponse

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

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:

Exception - Any exception

addPeerReachableListener

public void addPeerReachableListener(PeerReachable peerReachable)

removePeerReachableListener

public void removePeerReachableListener(PeerReachable peerReachable)

addPeerReceivedBroadcastPingListener

public void addPeerReceivedBroadcastPingListener(PeerReceivedBroadcastPing peerReceivedBroadcastPing)

removePeerReceivedBroadcastPingListener

public void removePeerReceivedBroadcastPingListener(PeerReceivedBroadcastPing peerReceivedBroadcastPing)