Skip to content

Class UpnpClient

🏭 Constructors

constructor

ts
UpnpClient(ssdp: Ssdp): UpnpClient

Parameters

  • ssdp: Ssdp

Return Type

  • UpnpClient

Defined in: packages/nat-api/lib/upnp.ts:72

🏷️ Properties

timeout readonly

ts
timeout: number

Defined in: packages/nat-api/lib/upnp.ts:64

🔧 Methods

destroy

ts
destroy(): void

Return Type

  • void

Defined in: packages/nat-api/lib/upnp.ts:264

externalIp

ts
externalIp(): Promise<string>

Return Type

  • Promise<string>

Defined in: packages/nat-api/lib/upnp.ts:201

findGateway

ts
findGateway(): Promise<{ address: AddressInfo; device: Device }>

Return Type

  • Promise<{ address: AddressInfo; device: Device }>

Defined in: packages/nat-api/lib/upnp.ts:220

getMappings

ts
getMappings(options: GetMappingOptions= {}): Promise<MappingInfo[]>

Parameters

  • options: GetMappingOptions

Return Type

  • Promise<MappingInfo[]>

Defined in: packages/nat-api/lib/upnp.ts:139

map

ts
map(options: UpnpMapOptions): Promise<void>

Parameters

  • options: UpnpMapOptions

Return Type

  • Promise<void>

Defined in: packages/nat-api/lib/upnp.ts:77

unmap

ts
unmap(options: UpnpUnmapOptions): Promise<boolean>

Parameters

  • options: UpnpUnmapOptions

Return Type

  • Promise<boolean>

Defined in: packages/nat-api/lib/upnp.ts:109