JS API Reference
Class: NetworkNode
network/node.NetworkNode
Describes a node in a VPN, mapping a Golem node id to an IP address
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new NetworkNode(id
, ip
, getNetworkInfo
, apiUrl
): NetworkNode
Parameters
Name | Type |
---|---|
id | string |
ip | IPv4 |
getNetworkInfo | () => NetworkInfo |
apiUrl | string |
Returns
Defined in
Properties
id
• Readonly
id: string
Defined in
ip
• Readonly
ip: IPv4
Defined in
Methods
getNetworkConfig
▸ getNetworkConfig(): Object
Generate a dictionary of arguments that are required for the appropriate Deploy
command of an exescript in order to pass the network configuration to the runtime on the provider's end.
Returns
Object
Name | Type |
---|---|
net | { nodeIp : string ; id : string ; ip : string ; mask : string ; nodes : { [ip: string] : string ; } }[] |
Defined in
getWebsocketUri
▸ getWebsocketUri(port
): string
Get the websocket URI corresponding with a specific TCP port on this Node.
Parameters
Name | Type | Description |
---|---|---|
port | number | TCP port of the service within the runtime |
Returns
string
the url