Skip to content

@pumpkin-plugins/port-mapping API / natpmp / NatPmpGateway

Class: NatPmpGateway ​

Defined in: tools/port-mapping/src/natpmp.ts:76

A router reached with NAT-PMP.

Implements ​

Constructors ​

Constructor ​

new NatPmpGateway(net, address, port?): NatPmpGateway

Defined in: tools/port-mapping/src/natpmp.ts:81

Creates a gateway at the given address. Nothing is sent until it is used.

Parameters ​

net ​

Network

address ​

Ipv4

port? ​

number = NAT_PMP_PORT

Returns ​

NatPmpGateway

Methods ​

addMapping() ​

addMapping(request): Steps<MappingResult>

Defined in: tools/port-mapping/src/natpmp.ts:95

Opens or renews a port.

Parameters ​

request ​

MappingRequest

Returns ​

Steps<MappingResult>

Implementation of ​

Gateway.addMapping


deleteMapping() ​

deleteMapping(request): Steps<void>

Defined in: tools/port-mapping/src/natpmp.ts:106

Closes a port. Closing one that isn't open is not an error.

Parameters ​

request ​

MappingRequest

Returns ​

Steps<void>

Implementation of ​

Gateway.deleteMapping


externalAddress() ​

externalAddress(): Steps<Ipv4>

Defined in: tools/port-mapping/src/natpmp.ts:90

The router's address on the internet side.

Returns ​

Steps<Ipv4>

Implementation of ​

Gateway.externalAddress

Pumpkin Plugins documentation