WebSocketConnectionConnected Property

This property is used to disconnect individual connections and/or show their status.

Syntax

 websocketserver.getWebSocketConnectionConnected(index, [callback])
 websocketserver.setWebSocketConnectionConnected(index,  webSocketConnectionConnected, [callback])

Default Value

FALSE

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 getWebSocketConnectionConnected([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 setWebSocketConnectionConnected([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 is used to disconnect individual connections and/or show their status.

The WebSocketConnectionConnected property may be set to false to close the connection.

WebSocketConnectionConnected also shows the status of a particular connection (connected/disconnected).

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 not available at design time.

Data Type

Boolean