@pumpkin-plugins/port-mapping API / upnp / UpnpGateway

Class: UpnpGateway

Defined in: tools/port-mapping/src/upnp.ts:133

A router reached with UPnP IGD.

Implements

• Gateway

Constructors

Constructor

new UpnpGateway(net, control): UpnpGateway

Defined in: tools/port-mapping/src/upnp.ts:143

Creates a gateway for one control point.

Parameters

net

Network

control

ControlPoint

Returns

UpnpGateway

Throws

When the control URL isn't an http:// URL with an IPv4 host.

Methods

addMapping()

addMapping(request, internalClient): Steps<MappingResult>

Defined in: tools/port-mapping/src/upnp.ts:163

Opens or renews a port.

Parameters

request

MappingRequest

internalClient

Ipv4

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

Returns

Steps<MappingResult>

Implementation of

Gateway.addMapping

---

deleteMapping()

deleteMapping(request): Steps<void>

Defined in: tools/port-mapping/src/upnp.ts:191

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/upnp.ts:155

The router's address on the internet side.

Returns

Steps<Ipv4>

Implementation of

Gateway.externalAddress