WebSocketConnectionAcceptData Property

Setting this property to False, temporarily disables data reception (and the DataIn event) on the connection.

Syntax

 websocketserver.getWebSocketConnectionAcceptData(index, [callback])
 websocketserver.setWebSocketConnectionAcceptData(index,  webSocketConnectionAcceptData, [callback])

Default Value

TRUE

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 getWebSocketConnectionAcceptData([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 setWebSocketConnectionAcceptData([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

Setting this property to False, temporarily disables data reception (and the DataIn event) on the connection. Setting this to True, re-enables data reception.

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