net.tomp2p.rpc

Class QuitRPC

java.lang.Object

net.tomp2p.rpc.DispatchHandler

net.tomp2p.rpc.QuitRPC

public class QuitRPC
extends DispatchHandler

This Quit RPC is used to send friendly shutdown messages by peers that are shutdown regularly.

Author:

Thomas Bocek

Constructor Summary

Constructors

Constructor and Description
QuitRPC(PeerBean peerBean, ConnectionBean connectionBean) Constructor that registers this RPC with the message handler.

Method Summary

Methods

Modifier and Type	Method and Description
QuitRPC	addPeerStatusListener(PeerStatusListener listener) Add a peer status listener that gets notified when a peer is offline.
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.
FutureResponse	quit(PeerAddress remotePeer, ShutdownBuilder shutdownBuilder, ChannelCreator channelCreator) Sends a message that indicates this peer is about to quit.

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

Constructor Detail

QuitRPC

public QuitRPC(PeerBean peerBean,
       ConnectionBean connectionBean)

Constructor that registers this RPC with the message handler.

Parameters:

peerBean - The peer bean that contains data that is unique for each peer

connectionBean - The connection bean that is unique per connection (multiple peers can share a single connection)

Method Detail

addPeerStatusListener

public QuitRPC addPeerStatusListener(PeerStatusListener listener)

Add a peer status listener that gets notified when a peer is offline.

Parameters:

listener - The listener

Returns:

This class

quit

public FutureResponse quit(PeerAddress remotePeer,
                  ShutdownBuilder shutdownBuilder,
                  ChannelCreator channelCreator)

Sends a message that indicates this peer is about to quit. This is an RPC.

Parameters:

remotePeer - The remote peer to send this request

shutdownBuilder - Used for the sign and force TCP flag Set if the message should be signed

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 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