IPWorks WebSockets 2020 Node.js Edition

Questions / Feedback?

AcceptData Property

Enables or disables data reception (the DataIn event).

Syntax

 websocketclient.getAcceptData([callback])
 websocketclient.setAcceptData( acceptData, [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 getAcceptData([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 setAcceptData([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 enables or disables data reception (the DataIn event). Setting this property to False, temporarily disables data reception (and the DataIn event). Setting this property to True, re-enables data reception.

This property is not available at design time.

Data Type

Boolean

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