IPWorks WebSockets 2020 Node.js Edition

Questions / Feedback?

BytesSent Property

The number of bytes actually sent after an assignment to DataToSend .

Syntax

 websocketclient.getBytesSent([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 getBytesSent([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 setBytesSent([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 indicates how many bytes were sent after the last assignment to DataToSend. Please check the DataToSend property for more information.

Note that BytesSent will always return 0 when the class is operating in synchronous mode (that is, the Timeout property is set to a positive value.)

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

Data Type

Integer

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