EOL Property

Used to break the incoming data stream into chunks separated by EOL.

Syntax

 ipport.getEOL([callback])
 ipport.setEOL( EOL_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 getEOL([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 setEOL([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 is used to define boundaries in the input stream using the value of the property.

This property is especially useful with ASCII files. Setting it to CRLF ("\r\ n") enables splitting of the incoming ASCII text stream into defined 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.

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

Data Type

Buffer