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, NATUtils natUtils, RelayRPC relayRPC, boolean manualPorts, ConnectionConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isManualPorts()
NATUtils	natUtils()
Peer	peer()
RelayRPC	relayRPC()
Ports	setupPortforwarding(String internalHost, Ports ports) The Dynamic and/or Private Ports are those from 49152 through 65535 (http://www.iana.org/assignments/port-numbers).
FutureRelayNAT	startRelay(RelayConfig relayConfig, BootstrapBuilder bootstrapBuilder)
FutureRelayNAT	startRelay(RelayConfig relayConfig, FutureDiscover futureDiscover)
FutureRelayNAT	startRelay(RelayConfig relayConfig, FutureDiscover futureDiscover, FutureNAT futureNAT)
FutureRelayNAT	startRelay(RelayConfig relayConfig, PeerAddress peerAddress)
FutureNAT	startSetupPortforwarding(FutureDiscover futureDiscover) Setup UPNP or NATPMP port forwarding.
FutureDone<PeerConnection>	startSetupRcon(PeerAddress relayPeerAddress, PeerAddress unreachablePeerAddress) This Method creates a PeerConnection to an unreachable (behind a NAT) peer using an active relay of the unreachable peer.

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,
       NATUtils natUtils,
       RelayRPC relayRPC,
       boolean manualPorts,
       ConnectionConfiguration config)

Method Detail

peer

public Peer peer()

natUtils

public NATUtils natUtils()

relayRPC

public RelayRPC relayRPC()

isManualPorts

public boolean isManualPorts()

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,
                        Ports ports)

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

startRelay

public FutureRelayNAT startRelay(RelayConfig relayConfig,
                        PeerAddress peerAddress)

startRelay

public FutureRelayNAT startRelay(RelayConfig relayConfig,
                        BootstrapBuilder bootstrapBuilder)

startRelay

public FutureRelayNAT startRelay(RelayConfig relayConfig,
                        FutureDiscover futureDiscover)

startRelay

public FutureRelayNAT startRelay(RelayConfig relayConfig,
                        FutureDiscover futureDiscover,
                        FutureNAT futureNAT)

startSetupRcon

public FutureDone<PeerConnection> startSetupRcon(PeerAddress relayPeerAddress,
                                        PeerAddress unreachablePeerAddress)

This Method creates a PeerConnection to an unreachable (behind a NAT) peer using an active relay of the unreachable peer. The connection will be kept open until close() is called.

Parameters:

relayPeerAddress -

unreachablePeerAddress -

timeoutSeconds -

Returns:

FutureDone

Throws:

TimeoutException