@pumpkin-plugins/port-mapping API / gateway / Gateway

Interface: Gateway

Defined in: tools/port-mapping/src/gateway.ts:34

A router that can open ports, reached through one protocol.

Methods

addMapping()

addMapping(request, internalClient): Steps<MappingResult>

Defined in: tools/port-mapping/src/gateway.ts:44

Opens or renews a port.

Parameters

request

MappingRequest

internalClient

Ipv4

This machine's address on the router's network.

Returns

Steps<MappingResult>

Throws

When the external port is taken.

---

deleteMapping()

deleteMapping(request): Steps<void>

Defined in: tools/port-mapping/src/gateway.ts:46

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

Parameters

request

MappingRequest

Returns

Steps<void>

---

externalAddress()

externalAddress(): Steps<Ipv4>

Defined in: tools/port-mapping/src/gateway.ts:38

The router's address on the internet side.

Returns

Steps<Ipv4>