Skip to content
Last Updated
Mar 28, 2025, 03:08

Class PmpClient ​

🏭 Constructors ​

constructor ​

ts
PmpClient(gateway: string, socket: Socket): PmpClient

Parameters ​

  • gateway: string
  • socket: Socket

Return Type ​

  • PmpClient

Defined in: packages/nat-api/lib/pmp.ts:56

🏷️ Properties ​

gateway readonly ​

ts
gateway: string

Defined in: packages/nat-api/lib/pmp.ts:56

socket readonly ​

ts
socket: Socket

Defined in: packages/nat-api/lib/pmp.ts:56

🔧 Methods ​

close ​

ts
close(): void

Return Type ​

  • void

Defined in: packages/nat-api/lib/pmp.ts:87

externalIp ​

ts
externalIp(): Promise<void>

Return Type ​

  • Promise<void>

Defined in: packages/nat-api/lib/pmp.ts:82

map ​

ts
map(opts: PmpMapOptions): Promise<void>

Parameters ​

  • opts: PmpMapOptions

Return Type ​

  • Promise<void>

Defined in: packages/nat-api/lib/pmp.ts:60

unmap ​

ts
unmap(opts: PmpMapOptions): Promise<void>

Parameters ​

  • opts: PmpMapOptions

Return Type ​

  • Promise<void>

Defined in: packages/nat-api/lib/pmp.ts:76