rice.pastry.client
Class PastryAppl
- public abstract class PastryAppl
- implements rice.pastry.messaging.MessageReceiver
- A PastryAppl is an abstract class that every Pastry application extends. This is the external Pastry API.
- Version:
- $Id: PastryAppl.java,v 1.15 2002/08/09 00:26:10 ssiyer Exp $
- Author:
- Peter Druschel
PastryAppl
public PastryAppl(rice.pastry.PastryNode pn)
- Constructor.
- Parameters:
pn
- the pastry node that client will attach to.
registerReceiver
public final void registerReceiver(rice.pastry.security.Credentials cred,
rice.pastry.messaging.Address addr,
rice.pastry.messaging.MessageReceiver mr)
- Registers a message receiver with the pastry node. This binds the given address to a message receiver. This binding is certified by the given credentials. Messages that are delivered to this node with the given address as a destination are forwarded to the supplied receiver.
- Parameters:
cred
- credentials which verify the binding
addr
- an address
mr
- a message receiver which will be bound the address.
sendMessage
public final void sendMessage(rice.pastry.messaging.Message msg)
- Sends a message directly to the local pastry node.
- Parameters:
msg
- a message.
receiveMessage
public final void receiveMessage(rice.pastry.messaging.Message msg)
- Called by pastry to deliver a message to this client. Not to be overridden.
- Parameters:
msg
- the message that is arriving.
getNodeId
public final rice.pastry.NodeId getNodeId()
- Gets the node id associated with this client.
- Returns:
- the node id.
routeMsgDirect
public boolean routeMsgDirect(rice.pastry.NodeHandle dest,
rice.pastry.messaging.Message msg,
rice.pastry.security.Credentials cred,
rice.pastry.routing.SendOptions opt)
- Sends a message to the Pastry node identified by dest. If that node has failed or no point-to-point connection can be established to the node from the local node in the Internet, the operation fails. Note that in this case, it may still be possible to send the message to that node using routeMsg.
- Parameters:
dest
- the destination node
msg
- the message to deliver.
cred
- credentials that verify the authenticity of the message.
opt
- send options that describe how the message is to be routed.
routeMsg
public void routeMsg(rice.pastry.NodeId key,
rice.pastry.messaging.Message msg,
rice.pastry.security.Credentials cred,
rice.pastry.routing.SendOptions opt)
- Routes a message to the live node D with nodeId numerically closest to key (at the time of delivery). The message is delivered to the application with address addr at D, and at each Pastry node encountered along the route to D.
- Parameters:
key
- the key
msg
- the message to deliver.
cred
- credentials that verify the authenticity of the message.
opt
- send options that describe how the message is to be routed.
getLeafSet
public rice.pastry.leafset.LeafSet getLeafSet()
- Called by a layered Pastry application to obtain a copy of the leaf set. The leaf set contains the nodeId to IP address binding of the l/2 nodes with numerically closest counterclockwise and the l/2 nodes with numerically closest clockwise nodeIds, relatively to the local node's id.
- Returns:
- the local node's leaf set
getRoutingTable
public rice.pastry.routing.RoutingTable getRoutingTable()
- Called by a layered Pastry application to obtain a copy of the routing table. The routing table contains the nodeId to IP address bindings of R nodes that share the local node's id in the first n digits, and differ in the n+1th digit, for 0 <= n
<= ceiling(log_2^b N), where N is the total number of currently
live nodes in the Pastry network. The routing table may be
incomplete, may contain nodes that cannot be reached from the
local node or have failed, and the table may change at any
time.
isClosest
public boolean isClosest(rice.pastry.NodeId key)
- Called by the layered Pastry application to check if the local pastry node is the one that is currently closest to the object key id.
- Parameters:
key
- the object key id
- Returns:
- true if the local node is currently the closest to the key.
getAddress
public abstract rice.pastry.messaging.Address getAddress()
- Returns the address of this application.
- Returns:
- the address.
getCredentials
public abstract rice.pastry.security.Credentials getCredentials()
- Returns the credentials of this application.
- Returns:
- the credentials.
messageForAppl
public abstract void messageForAppl(rice.pastry.messaging.Message msg)
- Called by pastry when a message arrives for this application.
- Parameters:
msg
- the message that is arriving.
enrouteMessage
public boolean enrouteMessage(rice.pastry.messaging.Message msg,
rice.pastry.NodeId key,
rice.pastry.NodeId nextHop,
rice.pastry.routing.SendOptions opt)
- Called by pastry when a message is enroute and is passing through this node. If this method is not overridden, the default behaviour is to let the message pass through.
- Parameters:
msg
- the message that is passing through.
key
- the key
nextHop
- the default next hop for the message.
opt
- the send options the message was sent with.
- Returns:
- true if the message should be routed, false if the message should be cancelled.
leafSetChange
public void leafSetChange(rice.pastry.NodeHandle nh,
boolean wasAdded)
- Called by pastry when the leaf set changes.
- Parameters:
nh
- the handle of the node that was added or removed.
wasAdded
- true if the node was added, false if the node was removed.
routeSetChange
public void routeSetChange(rice.pastry.NodeHandle nh,
boolean wasAdded)
- Called by pastry when the route set changes.
- Parameters:
nh
- the handle of the node that was added or removed.
wasAdded
- true if the node was added, false if the node was removed.
notifyReady
public void notifyReady()
- Invoked when the Pastry node has joined the overlay network and is ready to send and receive messages