IPWorks IPC 2020 Python Edition

Questions / Feedback?

eol Property

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

Syntax

def get_eol(connection_id: int) -> bytes: ...
def set_eol(connection_id: int, value: bytes) -> None: ...

Default Value

""

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 connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the connection_count property.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IPC 2020 Python Edition - Version 20.0 [Build 8162]