Back to Adaptive Vision Library website
You are here: Start » Function Reference » TCP IP » TcpIp_ReadAll_Deprecated
Receives octets from a connected socket until the other side finishes sending.
Syntax
void avl::TcpIp_ReadAll_Deprecated ( avl::SocketId inSocket, const atl::Optional<int>& inTimeout, atl::Conditional<atl::String>& outText, atl::Array<int>& outBytes, bool& outEof )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inSocket | SocketId | Connected socket ID, will be closed if successfully read. | |||
inTimeout | const Optional<int>& | 0 - | NIL | Timeout in milliseconds, block if not specified. | |
outText | Conditional<String>& | Received data as textual string. | |||
outBytes | Array<int>& | Received octets as integer values. | |||
outEof | bool& | Whether everything has been read and socket is closed. |
Description
This filter is deprecated. Use TcpIp_ReadAllText or TcpIp_ReadAllBuffer instead.
Multithreaded environment
This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.