IPWorks WebSockets 2020 Node.js Edition

Questions / Feedback?

WebSocketProxyConnectionConnectionId Property

This property contains an identifier generated by the class to identify each connection.

Syntax

 websocketproxy.getWebSocketProxyConnectionConnectionId(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 getWebSocketProxyConnectionConnectionId([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 setWebSocketProxyConnectionConnectionId([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 contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.

The size of the array is controlled by the WebSocketProxyConnectionCount 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]