SingleLineMode Property

Special mode for line-oriented protocols.

Syntax

 ipport.getSingleLineMode([callback])
 ipport.setSingleLineMode( singleLineMode, [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 getSingleLineMode([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 setSingleLineMode([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

When this property is set to True, the class treats the incoming data stream as lines separated by CRLF, CR, or LF. The EOL property is ignored.

AcceptData will be automatically set to False when this property is set to True. Please refer to the GetLine method for more information.

This property is not available at design time.

Data Type

Boolean

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