@pumpkin-plugins/port-mapping API / discover / DiscoveryOptions
Interface: DiscoveryOptions ​
Defined in: tools/port-mapping/src/discover.ts:14
What to look for and where.
Properties ​
natPmp ​
natPmp:
boolean
Defined in: tools/port-mapping/src/discover.ts:18
Look for NAT-PMP gateways.
natPmpGateway? ​
optionalnatPmpGateway?:Endpoint
Defined in: tools/port-mapping/src/discover.ts:22
The NAT-PMP gateway to use. Without it the usual router addresses of the local network are tried.
screen? ​
optionalscreen?:Screen
Defined in: tools/port-mapping/src/discover.ts:30
Turns routers down by what they are. It sees every router that gives away its make and model, before anything is asked of it, and a router it gives a reason for is not used: when that leaves no router, discovery throws a RouterRefusedError. Without it routers are not identified.
searchMs? ​
optionalsearchMs?:number
Defined in: tools/port-mapping/src/discover.ts:24
How long a UPnP search waits for answers, in milliseconds.
ssdp? ​
optionalssdp?:Endpoint
Defined in: tools/port-mapping/src/discover.ts:20
Where to send UPnP searches. Defaults to the SSDP multicast group; a router's own address works when multicast is blocked.
upnp ​
upnp:
boolean
Defined in: tools/port-mapping/src/discover.ts:16
Look for UPnP gateways.