IPWorks WebSockets 2020 Node.js Edition

Questions / Feedback?

WebSocketConnectionLocalAddress Property

This property shows the IP address of the interface through which the connection is passing.

Syntax

 websocketserver.getWebSocketConnectionLocalAddress(index, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getWebSocketConnectionLocalAddress([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setWebSocketConnectionLocalAddress([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property shows the IP address of the interface through which the connection is passing.

WebSocketConnectionLocalAddress is important for multi-homed hosts where it can be used to find which particular network interface an individual connection is going through.

The size of the array is controlled by the WebSocketConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks WebSockets 2020 Node.js Edition - Version 20.0 [Build 7721]