ClientSingleLineMode Property

This property shows the special mode for line-oriented protocols.

Syntax

 sshtunnel.getClientSingleLineMode(index, [callback])
 sshtunnel.setClientSingleLineMode(index,  clientSingleLineMode, [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 getClientSingleLineMode([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 setClientSingleLineMode([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 shows the special mode for line-oriented protocols. When SingleLineMode is True, the class treats the incoming data stream as lines separated by CRLF, CR, or LF. The EOL property is ignored.

The size of the array is controlled by the ClientCount property.

This property is not available at design time.

Data Type

Boolean