net.tomp2p.p2p

Class Peer

java.lang.Object

net.tomp2p.p2p.Peer

public class Peer
extends Object

This is the main class to start DHT operations. This class makes use of the build pattern and for each DHT operation, a builder class is returned. The main operations can be initiated with put(Number160), get(Number160), add(Number160), addTracker(Number160), getTracker(Number160), remove(Number160), #submit(Number160, Worker), send(Number160), #sendDirect(), broadcast(Number160). Each of those operations return a builder that offers more options. One of the main difference to a "regular" DHT is that TomP2P can store a map (key-values) instead of just values. To distinguish those, the keys are termed location key (for finding the right peer in the network), and content key (to store more than one value on a peer). For the put builder e.g. the following options can be set:

• PutBuilder.setData(Number160, net.tomp2p.storage.Data) - puts a content key with a value
• {@link PutBuilder#setDataMap(Map) - puts multiple content key / values at once
• {@link PutBuilder#setPutIfAbsent() - only puts data if its not already on the peers
• ...

Furthermore, TomP2P also provides to store keys in different domains to avoid key collisions ({@link PutBuilder#setDomainKey(Number160)).

Author:

Thomas Bocek

Method Summary

Methods

Modifier and Type	Method and Description
AddBuilder	add(Number160 locationKey)
void	addShutdownListener(Shutdown shutdown)
AddTrackerBuilder	addTracker(Number160 locationKey)
ShutdownBuilder	announceShutdown() Sends a friendly shutdown message to my close neighbors in the DHT.
BootstrapBuilder	bootstrap()
BroadcastBuilder	broadcast(Number160 messageKey)
FuturePeerConnection	createPeerConnection(PeerAddress destination)
FuturePeerConnection	createPeerConnection(PeerAddress destination, int heartBeatMillis) Opens a TCP connection and keeps it open.
DigestBuilder	digest(Number160 locationKey)
DiscoverBuilder	discover()
GetBuilder	get(Number160 locationKey)
BroadcastRPC	getBroadcastRPC()
ConnectionBean	getConnectionBean()
DirectDataRPC	getDirectDataRPC()
DistributedHashTable	getDistributedHashMap()
DistributedRouting	getDistributedRouting()
DistributedTracker	getDistributedTracker()
PingRPC	getHandshakeRPC()
NeighborRPC	getNeighborRPC()
int	getP2PID()
PeerAddress	getPeerAddress()
PeerBean	getPeerBean()
PeerExchangeRPC	getPeerExchangeRPC()
Number160	getPeerID()
QuitRPC	getQuitRPC()
StorageRPC	getStoreRPC()
GetTrackerBuilder	getTracker(Number160 locationKey)
TrackerRPC	getTrackerRPC()
boolean	isShutdown()
Peer	notifyAutomaticFutures(BaseFuture future)
ParallelRequestBuilder<?>	parallelRequest(Number160 locationKey)
PingBuilder	ping()
PutBuilder	put(Number160 locationKey)
RemoveBuilder	remove(Number160 locationKey)
void	removeShutdownListener(Shutdown shutdown)
SendBuilder	send(Number160 locationKey) The send method works as follows:
SendDirectBuilder	sendDirect(FuturePeerConnection recipientConnection)
SendDirectBuilder	sendDirect(PeerAddress recipientAddress)
SendDirectBuilder	sendDirect(PeerConnection peerConnection)
void	setBroadcastRPC(BroadcastRPC broadcastRPC)
void	setDirectDataRPC(DirectDataRPC directDataRPC)
void	setDistributedHashMap(DistributedHashTable distributedHashMap)
void	setDistributedRouting(DistributedRouting distributedRouting)
void	setDistributedTracker(DistributedTracker distributedTracker)
void	setHandshakeRPC(PingRPC handshakeRPC)
void	setNeighborRPC(NeighborRPC neighborRPC)
void	setObjectDataReply(ObjectDataReply objectDataReply)
void	setPeerExchangeRPC(PeerExchangeRPC peerExchangeRPC)
void	setQuitRPC(QuitRPC quitRCP)
void	setRawDataReply(RawDataReply rawDataReply)
void	setStorageRPC(StorageRPC storageRPC)
void	setTrackerRPC(TrackerRPC trackerRPC)
BaseFuture	shutdown() Shuts down everything.

Methods inherited from class java.lang.Object

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

Method Detail

getHandshakeRPC

public PingRPC getHandshakeRPC()

setHandshakeRPC

public void setHandshakeRPC(PingRPC handshakeRPC)

getStoreRPC

public StorageRPC getStoreRPC()

setStorageRPC

public void setStorageRPC(StorageRPC storageRPC)

getNeighborRPC

public NeighborRPC getNeighborRPC()

setNeighborRPC

public void setNeighborRPC(NeighborRPC neighborRPC)

getQuitRPC

public QuitRPC getQuitRPC()

setQuitRPC

public void setQuitRPC(QuitRPC quitRCP)

getPeerExchangeRPC

public PeerExchangeRPC getPeerExchangeRPC()

setPeerExchangeRPC

public void setPeerExchangeRPC(PeerExchangeRPC peerExchangeRPC)

getDirectDataRPC

public DirectDataRPC getDirectDataRPC()

setDirectDataRPC

public void setDirectDataRPC(DirectDataRPC directDataRPC)

getTrackerRPC

public TrackerRPC getTrackerRPC()

setTrackerRPC

public void setTrackerRPC(TrackerRPC trackerRPC)

setBroadcastRPC

public void setBroadcastRPC(BroadcastRPC broadcastRPC)

getBroadcastRPC

public BroadcastRPC getBroadcastRPC()

getDistributedRouting

public DistributedRouting getDistributedRouting()

setDistributedRouting

public void setDistributedRouting(DistributedRouting distributedRouting)

getDistributedHashMap

public DistributedHashTable getDistributedHashMap()

setDistributedHashMap

public void setDistributedHashMap(DistributedHashTable distributedHashMap)

getDistributedTracker

public DistributedTracker getDistributedTracker()

setDistributedTracker

public void setDistributedTracker(DistributedTracker distributedTracker)

getPeerBean

public PeerBean getPeerBean()

getConnectionBean

public ConnectionBean getConnectionBean()

getPeerID

public Number160 getPeerID()

getP2PID

public int getP2PID()

getPeerAddress

public PeerAddress getPeerAddress()

notifyAutomaticFutures

public Peer notifyAutomaticFutures(BaseFuture future)

setRawDataReply

public void setRawDataReply(RawDataReply rawDataReply)

setObjectDataReply

public void setObjectDataReply(ObjectDataReply objectDataReply)

createPeerConnection

public FuturePeerConnection createPeerConnection(PeerAddress destination)

createPeerConnection

public FuturePeerConnection createPeerConnection(PeerAddress destination,
                                        int heartBeatMillis)

Opens a TCP connection and keeps it open. The user can provide the idle timeout, which means that the connection gets closed after that time of inactivity. If the other peer goes offline or closes the connection (due to inactivity), further requests with this connections reopens the connection. This methods blocks until a connection can be reserver.

Parameters:

destination - The end-point to connect to

idleTCPMillis - time in milliseconds after a connection gets closed if idle, -1 if it should remain always open until the user closes the connection manually.

Returns:

A class that needs to be passed to those methods that should use the already open connection. If the connection could not be reserved, maybe due to a shutdown, null is returned.

add

public AddBuilder add(Number160 locationKey)

put

public PutBuilder put(Number160 locationKey)

get

public GetBuilder get(Number160 locationKey)

digest

public DigestBuilder digest(Number160 locationKey)

remove

public RemoveBuilder remove(Number160 locationKey)

send

public SendBuilder send(Number160 locationKey)

The send method works as follows:

 1. routing: find close peers to the content hash. 
    You can control the routing behavior with 
    setRoutingConfiguration() 
 2. sending: send the data to the n closest peers. 
    N is set via setRequestP2PConfiguration(). 
    If you want to send it to the closest one, use 
    setRequestP2PConfiguration(1, 5, 0)
 

Parameters:

locationKey - The target hash to search for during the routing process

Returns:

The send builder that allows to set options

sendDirect

public SendDirectBuilder sendDirect(PeerAddress recipientAddress)

sendDirect

public SendDirectBuilder sendDirect(FuturePeerConnection recipientConnection)

sendDirect

public SendDirectBuilder sendDirect(PeerConnection peerConnection)

bootstrap

public BootstrapBuilder bootstrap()

ping

public PingBuilder ping()

discover

public DiscoverBuilder discover()

addTracker

public AddTrackerBuilder addTracker(Number160 locationKey)

getTracker

public GetTrackerBuilder getTracker(Number160 locationKey)

parallelRequest

public ParallelRequestBuilder<?> parallelRequest(Number160 locationKey)

broadcast

public BroadcastBuilder broadcast(Number160 messageKey)

announceShutdown

public ShutdownBuilder announceShutdown()

Sends a friendly shutdown message to my close neighbors in the DHT.

Returns:

A builder for shutdown that runs asynchronous.

shutdown

public BaseFuture shutdown()

Shuts down everything. TODO: test in ExampleDirectReplication, when the direct replication was not yet shut down.

Returns:

The future, when shutdown is completed

isShutdown

public boolean isShutdown()

Returns:

True if the peer is about or already has shutdown

addShutdownListener

public void addShutdownListener(Shutdown shutdown)

removeShutdownListener

public void removeShutdownListener(Shutdown shutdown)