ClientEOL Property

The EOL property is used to define boundaries in the input stream using the value of the property.

Syntax

 sshtunnel.getClientEOL(index, [callback])
 sshtunnel.setClientEOL(index,  clientEOL_Buffer, [callback])

Default Value

""

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 getClientEOL([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setClientEOL([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

The EOL property is used to define boundaries in the input stream using the value of the property.

The EOL property is especially useful with ASCII files. Setting it to CRLF ("\r\ n") enables splitting of the incoming ASCII text stream into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF ("\r\ n") . bytes are discarded.

The EOL property is a binary string. In particular, this means that it can be more than one byte long, and it can contain NULL bytes.

When reading the value of the property, if ConnectionId does not belong to a valid connection, then NULL will be returned, and the LastError property will contain a corresponding error message. If no error is encountered, then LastError will contain NULL.

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

This property is not available at design time.

Data Type

Buffer