Package org.drasyl.remote.handler.portmapper

Class NatPmpPortMapping

java.lang.Object

org.drasyl.remote.handler.portmapper.NatPmpPortMapping

All Implemented Interfaces:

PortMapping

public class NatPmpPortMapping
extends Object
implements PortMapping

Port Forwarding on NAT-enabled routers via NAT-PMP.

This methods requires the following steps:

• identify own default network gateway
• request external address from gateway to ensure it is connected to a WAN
• request port mapping from gateway

Field Summary

Fields

Modifier and Type	Field	Description
static Duration	TIMEOUT

Constructor Summary

Constructors

Constructor	Description
NatPmpPortMapping()
NatPmpPortMapping(AtomicBoolean externalAddressRequested, AtomicBoolean mappingRequested, int port, InetSocketAddressWrapper defaultGateway, InetAddress externalAddress, io.reactivex.rxjava3.disposables.Disposable timeoutGuard, io.reactivex.rxjava3.disposables.Disposable refreshTask, Runnable onFailure, Supplier<InetAddress> defaultGatewaySupplier)

Method Summary

Modifier and Type	Method	Description
boolean	acceptMessage(AddressedByteBuf msg)	Is called for incoming messages and returns true if the message should be consumed and removed from the pipeline.
void	handleMessage(HandlerContext ctx, AddressedByteBuf msg)	Is called for incoming messages and thus enables this method to react to relevant messages.
void	start(HandlerContext ctx, NodeUpEvent event, Runnable onFailure)	Tells the method to create a port forwarding and renew it independently.
void	stop(HandlerContext ctx)	Shall remove any existing port forwarding again.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TIMEOUT

public static final Duration TIMEOUT

Constructor Detail

NatPmpPortMapping

public NatPmpPortMapping(AtomicBoolean externalAddressRequested,
                         AtomicBoolean mappingRequested,
                         int port,
                         InetSocketAddressWrapper defaultGateway,
                         InetAddress externalAddress,
                         io.reactivex.rxjava3.disposables.Disposable timeoutGuard,
                         io.reactivex.rxjava3.disposables.Disposable refreshTask,
                         Runnable onFailure,
                         Supplier<InetAddress> defaultGatewaySupplier)

NatPmpPortMapping

public NatPmpPortMapping()

Method Detail

start

public void start(HandlerContext ctx,
                  NodeUpEvent event,
                  Runnable onFailure)

Description copied from interface: PortMapping

Tells the method to create a port forwarding and renew it independently. If no forwarding can be created, onFailure must be called once.

Specified by:

start in interface PortMapping

Parameters:

ctx - the handler context

event - the node up event

onFailure - will be called once on failure

stop

public void stop(HandlerContext ctx)

Description copied from interface: PortMapping

Shall remove any existing port forwarding again.

Specified by:

stop in interface PortMapping

Parameters:

ctx - the handler context

acceptMessage

public boolean acceptMessage(AddressedByteBuf msg)

Description copied from interface: PortMapping

Is called for incoming messages and returns true if the message should be consumed and removed from the pipeline.

Specified by:

acceptMessage in interface PortMapping

Parameters:

msg - the message

Returns:

true if the message is relevant for the current port forwarding method. Otherwise false

handleMessage

public void handleMessage(HandlerContext ctx,
                          AddressedByteBuf msg)

Description copied from interface: PortMapping

Is called for incoming messages and thus enables this method to react to relevant messages.

Specified by:

handleMessage in interface PortMapping

Parameters:

ctx - the handler context

msg - the message

toString

public String toString()

Overrides:

toString in class Object