Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » TCP IP » TcpIp_ReadLine_Deprecated

TcpIp_ReadLine_Deprecated


Reads from a connected TCP socket until receiving a specific sequence.

Name Type Range Description
inSocket SocketId Connected socket ID.
inDelimiter String Terminating character sequence, escaped.
inTimeout Integer* 0 - Timeout in milliseconds, block if not specified.
inMode DelimiterHandling Delimiter handling mode - include with output, discard or preserve in buffer.
outText String? Received data as textual string.
outBytes IntegerArray Received octets as integer values.
outEof Bool Indicates whether the operation was interrupted on attempt to get data from beyond the end of stream

Description

This filter is deprecated. Use TcpIp_ReadLine instead.

Remarks

User manual

For more information about using this filter, please follow the link: Using TCP/IP Communication.

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Empty delimiter in TcpIp_ReadLine_Deprecated

Complexity Level

This filter is available on Basic Complexity Level.

Disabled in Lite Edition

This filter is disabled in Lite Edition. It is available only in full, Adaptive Vision Studio Professional version.