1.6 KiB
Vendored
id, sidebar_class_name
| id | sidebar_class_name |
|---|---|
| TCP | TCP |
<img src={require('../../static/img/APIs/TCP.png').default} width='64px' />
TCP (Client)
This section is dedicated to the library for working with the TCP. On this page, all the steps necessary to start working are described
About implemented methods
This library provides several ready-made methods for working as a TCP client. The standard scheme of interaction with the server is as follows:
1. The object is created and connected to the server using the `CreateConnection` function. The connection string in the format `<address>:<port>` is passed there.
2. If necessary, a message can be sent to the server using the `SendBinaryData` and `SendLine` functions
3. To receive data from the server, the `ReadBinaryData` and `ReadLine` functions are used. They have different parameters to limit the received data by size, token and waiting for input (timeout)
4. At the end of work it is desirable to explicitly terminate the connection using the `CloseConnection` function
For a simple scenario with standard settings, there is also the ProcessRequest function - it sends data to the specified address and waits for a response, finishing reading when the standard \\n token is found. It is also the only function that is available in the CLI version of the OPI
Compatibility
Technically, the client implementation is a Native component in Rust. It comes in a zip archive format, and, in theory, should work on all available platforms: x86 and x64 Windows and Linux. The actual testing was done on Windows x64 and, cossentially (via OneScript), on Linux x64