net.tomp2p.nat

Class PeerNAT

java.lang.Object

net.tomp2p.nat.PeerNAT

public class PeerNAT
extends Object

Constructor Summary

Constructors

Constructor and Description
PeerNAT(Peer peer)

Method Summary

Methods

Modifier and Type	Method and Description
BootstrapBuilder	bootstrapBuilder()
PeerNAT	bootstrapBuilder(BootstrapBuilder bootstrapBuilder) Specify a bootstrap builder that will be used to bootstrap during the process of setting up relay peers and after that.
PeerNAT	bootstrapBuilder(PeerAddress peerAddress)
int	failedRelayWaitTime()
PeerNAT	failedRelayWaitTime(int failedRelayWaitTime) Defines how many seconds to wait at least until asking a relay that denied a relay request or a relay that failed to act as a relay again
int	maxFail()
PeerNAT	maxFail(int maxFail)
int	minRelays()
PeerNAT	minRelays(int minRelays) Defines how many relays have to be set up.
int	peerMapUpdateInterval()
PeerNAT	peerMapUpdateInterval(int peerMapUpdateInterval) Defines the time interval of sending the peer map of the unreachable peer to its relays.
RelayRPC	relayRPC()
Collection<PeerAddress>	relays()
PeerNAT	relays(Collection<PeerAddress> relays)
Ports	setupPortforwarding(String internalHost) The Dynamic and/or Private Ports are those from 49152 through 65535 (http://www.iana.org/assignments/port-numbers).
FutureRelayNAT	startRelay()
FutureRelayNAT	startRelay(FutureNAT futureNAT)
Shutdown	startRelayMaintenance(FutureRelay futureRelay)
FutureNAT	startSetupPortforwarding(FutureDiscover futureDiscover) Setup UPNP or NATPMP port forwarding.
FutureRelay	startSetupRelay()
FutureRelay	startSetupRelay(FutureNAT futureNAT)

Methods inherited from class java.lang.Object

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

Constructor Detail

PeerNAT

public PeerNAT(Peer peer)

Method Detail

relayRPC

public RelayRPC relayRPC()

startSetupPortforwarding

public FutureNAT startSetupPortforwarding(FutureDiscover futureDiscover)

Setup UPNP or NATPMP port forwarding.

Parameters:

futureDiscover - The result of the discovery process. This information from the discovery process is important to setup UPNP or NATPMP. If this fails, then this future will also fail, and other means to connect to the network needs to be found.

Returns:

The future object that tells you if you are reachable (success), if UPNP or NATPMP could be setup and then you are reachable (success), or if it failed.

setupPortforwarding

public Ports setupPortforwarding(String internalHost)

The Dynamic and/or Private Ports are those from 49152 through 65535 (http://www.iana.org/assignments/port-numbers).

Parameters:

internalHost - The IP of the internal host

Returns:

The new external ports if port forwarding seemed to be successful, otherwise null

startSetupRelay

public FutureRelay startSetupRelay(FutureNAT futureNAT)

startSetupRelay

public FutureRelay startSetupRelay()

startRelayMaintenance

public Shutdown startRelayMaintenance(FutureRelay futureRelay)

startRelay

public FutureRelayNAT startRelay()

startRelay

public FutureRelayNAT startRelay(FutureNAT futureNAT)

failedRelayWaitTime

public PeerNAT failedRelayWaitTime(int failedRelayWaitTime)

Defines how many seconds to wait at least until asking a relay that denied a relay request or a relay that failed to act as a relay again

Parameters:

failedRelayWaitTime - wait time in seconds

Returns:

this instance

failedRelayWaitTime

public int failedRelayWaitTime()

Returns:

How many seconds to wait at least until asking a relay that denied a relay request or a relay that failed to act as a relay again

minRelays

public PeerNAT minRelays(int minRelays)

Defines how many relays have to be set up. If less than minRelays relay peers could be set up, it is considered a fail.

Parameters:

minRelays - minimum amount of relays

Returns:

this instance

minRelays

public int minRelays()

Returns:

How many relays have to be set up. If less than minRelays relay peers could be set up, it is considered a fail.

maxFail

public PeerNAT maxFail(int maxFail)

maxFail

public int maxFail()

peerMapUpdateInterval

public PeerNAT peerMapUpdateInterval(int peerMapUpdateInterval)

Defines the time interval of sending the peer map of the unreachable peer to its relays. The routing requests are not relayed to the unreachable peer but handled by the relay peers. Therefore, the relay peers should always have an up-to-date peer map of the relayed peer

Parameters:

peerMapUpdateInterval - interval of updates in seconds

Returns:

this instance

peerMapUpdateInterval

public int peerMapUpdateInterval()

Returns:

the peer map update interval in seconds

bootstrapBuilder

public PeerNAT bootstrapBuilder(BootstrapBuilder bootstrapBuilder)

Specify a bootstrap builder that will be used to bootstrap during the process of setting up relay peers and after that.

Parameters:

bootstrapBuilder - The bootstrap builder

Returns:

this instance

bootstrapBuilder

public PeerNAT bootstrapBuilder(PeerAddress peerAddress)

bootstrapBuilder

public BootstrapBuilder bootstrapBuilder()

Returns:

Get a bootstrap builder that will be used to bootstrap during the process of setting up relay peers and after that.

relays

public Collection<PeerAddress> relays()

relays

public PeerNAT relays(Collection<PeerAddress> relays)