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#dataMap(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
Peer	addAutomaticFuture(AutomaticFuture automaticFuture)
Peer	addShutdownListener(Shutdown shutdown)
AnnounceRPC	announceRPC()
Peer	announceRPC(AnnounceRPC announceRPC)
ShutdownBuilder	announceShutdown() Sends a friendly shutdown message to my close neighbors in the DHT.
BootstrapBuilder	bootstrap()
BroadcastBuilder	broadcast(Number160 messageKey)
BroadcastRPC	broadcastRPC()
Peer	broadcastRPC(BroadcastRPC broadcastRPC)
ConnectionBean	connectionBean()
FuturePeerConnection	createPeerConnection(PeerAddress destination)
FuturePeerConnection	createPeerConnection(PeerAddress destination, int heartBeatMillis) Opens a TCP connection and keeps it open.
DirectDataRPC	directDataRPC()
Peer	directDataRPC(DirectDataRPC directDataRPC)
DiscoverBuilder	discover()
DistributedRouting	distributedRouting()
void	distributedRouting(DistributedRouting distributedRouting)
boolean	isShutdown()
AnnounceBuilder	localAnnounce()
NeighborRPC	neighborRPC()
Peer	neighborRPC(NeighborRPC neighborRPC)
Peer	notifyAutomaticFutures(BaseFuture future)
void	objectDataReply(ObjectDataReply objectDataReply)
int	p2pId()
PeerAddress	peerAddress()
PeerBean	peerBean()
Number160	peerID()
PingBuilder	ping()
PingRPC	pingRPC()
Peer	pingRPC(PingRPC pingRCP)
QuitRPC	quitRPC()
Peer	quitRPC(QuitRPC quitRPC)
void	rawDataReply(RawDataReply rawDataReply)
Peer	removeAutomaticFuture(AutomaticFuture automaticFuture)
Peer	removeShutdownListener(Shutdown shutdown)
SendDirectBuilder	sendDirect(FuturePeerConnection recipientConnection)
SendDirectBuilder	sendDirect(PeerAddress recipientAddress)
SendDirectBuilder	sendDirect(PeerConnection peerConnection)
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

pingRPC

public PingRPC pingRPC()

pingRPC

public Peer pingRPC(PingRPC pingRCP)

quitRPC

public QuitRPC quitRPC()

quitRPC

public Peer quitRPC(QuitRPC quitRPC)

neighborRPC

public NeighborRPC neighborRPC()

neighborRPC

public Peer neighborRPC(NeighborRPC neighborRPC)

directDataRPC

public DirectDataRPC directDataRPC()

directDataRPC

public Peer directDataRPC(DirectDataRPC directDataRPC)

broadcastRPC

public BroadcastRPC broadcastRPC()

broadcastRPC

public Peer broadcastRPC(BroadcastRPC broadcastRPC)

announceRPC

public AnnounceRPC announceRPC()

announceRPC

public Peer announceRPC(AnnounceRPC announceRPC)

distributedRouting

public DistributedRouting distributedRouting()

distributedRouting

public void distributedRouting(DistributedRouting distributedRouting)

peerBean

public PeerBean peerBean()

connectionBean

public ConnectionBean connectionBean()

peerID

public Number160 peerID()

p2pId

public int p2pId()

peerAddress

public PeerAddress peerAddress()

notifyAutomaticFutures

public Peer notifyAutomaticFutures(BaseFuture future)

rawDataReply

public void rawDataReply(RawDataReply rawDataReply)

objectDataReply

public void objectDataReply(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 method blocks until a connection can be reserved.

Parameters:

destination - The end-point to connect to

heartBeatMillis - // TODO update doc 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.

sendDirect

public SendDirectBuilder sendDirect(PeerAddress recipientAddress)

sendDirect

public SendDirectBuilder sendDirect(FuturePeerConnection recipientConnection)

sendDirect

public SendDirectBuilder sendDirect(PeerConnection peerConnection)

bootstrap

public BootstrapBuilder bootstrap()

announceShutdown

public ShutdownBuilder announceShutdown()

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

Returns:

A builder for shutdown that runs asynchronous.

ping

public PingBuilder ping()

discover

public DiscoverBuilder discover()

broadcast

public BroadcastBuilder broadcast(Number160 messageKey)

shutdown

public BaseFuture shutdown()

Shuts down everything.

Returns:

The future, when shutdown is completed

isShutdown

public boolean isShutdown()

Returns:

True if the peer is about or already has shutdown

addShutdownListener

public Peer addShutdownListener(Shutdown shutdown)

removeShutdownListener

public Peer removeShutdownListener(Shutdown shutdown)

addAutomaticFuture

public Peer addAutomaticFuture(AutomaticFuture automaticFuture)

removeAutomaticFuture

public Peer removeAutomaticFuture(AutomaticFuture automaticFuture)

localAnnounce

public AnnounceBuilder localAnnounce()