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

TcpIp_ReadLine_Deprecated

Header:	STD.h
Namespace:	fil

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

Syntax

void fil::TcpIp_ReadLine_Deprecated
(
	fil::SocketId inSocket,
	const ftl::String& inDelimiter,
	const ftl::Optional<int>& inTimeout,
	fil::DelimiterHandling::Type inMode,
	ftl::Conditional<ftl::String>& outText,
	ftl::Array<int>& outBytes,
	bool& outEof
)

Parameters

Name	Type	Range	Default	Description
inSocket	SocketId			Connected socket ID.
inDelimiter	const String&		\"\\\\r\\\\n\"	Terminating character sequence, escaped.
inTimeout	const Optional<int>&	0 -	NIL	Timeout in milliseconds, block if not specified.
inMode	DelimiterHandling::Type			Delimiter handling mode - include with output, discard or preserve in buffer.
outText	Conditional<String>&			Received data as textual string.
outBytes	Array<int>&			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.

Multithreaded environment

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

Errors

List of possible exceptions:

Error type	Description
DomainError	Empty delimiter in TcpIp_ReadLine_Deprecated