Class NetworkNode

Hierarchy (view full)

Network
- NetworkNode

Index

Constructors

Properties

Methods

close createUdpChannel getIpMac getNetInterfaces getMembershipMulticastInterfaces getMulticastInterfaceIpv4 getNetInterfaceForIp getNetInterfaceZoneIpv6

Constructors

constructor

new NetworkNode(): NetworkNode
Returns NetworkNode
Inherited from Network.constructor

Properties

`Static`get

get: (() => Network)

Methods

close

close(): Promise<void>
Returns Promise<void>
Overrides Network.close
- Defined in packages/nodejs/dist/esm/net/NodeJsNetwork.d.ts:13

createUdpChannel

createUdpChannel(options): Promise<UdpChannel>
Parameters
- options: UdpChannelOptions
Returns Promise<UdpChannel>
Overrides Network.createUdpChannel
- Defined in packages/nodejs/dist/esm/net/NodeJsNetwork.d.ts:25

getIpMac

getIpMac(netInterface): undefined | NetworkInterfaceDetails
Parameters
- netInterface: string
Returns undefined | NetworkInterfaceDetails
Overrides Network.getIpMac
- Defined in packages/nodejs/dist/esm/net/NodeJsNetwork.d.ts:24

getNetInterfaces

getNetInterfaces(configuration?): NetworkInterface[]
Get all network interfaces. The optional configuration parameter allows to map interface names to types if this mapping is known. Each network interface which has no mapped type is returned as Ethernet for now.
Parameters
- Optionalconfiguration: NetworkInterface[]
  An array of objects with the name and type properties.
Returns NetworkInterface[]
Overrides Network.getNetInterfaces
- Defined in packages/nodejs/dist/esm/net/NodeJsNetwork.d.ts:23

`Static`getMembershipMulticastInterfaces

getMembershipMulticastInterfaces(netInterface, ipv4): (undefined | string)[]
Parameters
- netInterface: undefined | string
- ipv4: boolean
Returns (undefined | string)[]
- Defined in packages/nodejs/dist/esm/net/NodeJsNetwork.d.ts:9

`Static`getMulticastInterfaceIpv4

getMulticastInterfaceIpv4(netInterface): undefined | string
Parameters
- netInterface: string
Returns undefined | string
- Defined in packages/nodejs/dist/esm/net/NodeJsNetwork.d.ts:8

`Static`getNetInterfaceForIp

getNetInterfaceForIp(ip): undefined | string
Parameters
- ip: string
Returns undefined | string
- Defined in packages/nodejs/dist/esm/net/NodeJsNetwork.d.ts:11

`Static`getNetInterfaceZoneIpv6

getNetInterfaceZoneIpv6(netInterface): undefined | string
Parameters
- netInterface: string
Returns undefined | string
- Defined in packages/nodejs/dist/esm/net/NodeJsNetwork.d.ts:10