IPWorks WebSockets 2020 Node.js Edition

Questions / Feedback?

WebSocketConnectionRemotePort Property

This property shows the port of the connected client.

Syntax

 websocketserver.getWebSocketConnectionRemotePort(index, [callback])

Default Value

0

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 getWebSocketConnectionRemotePort([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 setWebSocketConnectionRemotePort([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 port of the connected client.

The connection must be valid or an error will be fired.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the WebSocketConnectionCount property.

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

Data Type

Integer

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