1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-03-21 21:27:27 +02:00
OpenIntegrations/docs/en/md/TCP/Tcp-client/Read-binary-data.mdx
Vitaly the Alpaca (bot) 95b0a3a934 Main build (Jenkins)
2024-12-16 20:23:39 +03:00

62 lines
1.8 KiB
Plaintext

---
sidebar_position: 3
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Read binary data
Reads data from the specified connection
`Function ReadBinaryData(Val Connection, Val MaxSize = 0, Val Marker = "", Val Timeout = 5000) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Connection | - | Arbitrary | ✔ | Connection, see. CreateConnection |
| MaxSize | - | Number | ✖ | Maximum data size (bytes). 0 > no limit |
| Marker | - | String, BinaryData | ✖ | End of message marker. Empty > without marker |
| Timeout | - | Number | ✖ | Data waiting timeout (ms). 0 > no limit |
Returns: BinaryData - Received data
<br/>
:::tip
When working with an infinite stream of incoming data, it is obligatory to specify the MaxSize parameter, because endless data retrieval can cause hang-ups
If the connection is closed, an error occurs, or EOF is detected, the read is terminated in either case
Parameters with Binary data type can also accept file paths on disk and URLs
:::
:::caution
**NOCLI:** данный метод недоступен для использования в CLI версии
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
Address = "45.79.112.203:4242";
Connection = OPI_TCP.CreateConnection(Address);
Message = "Hello server!" + Chars.LF;
Data = ПолучитьДвоичныеДанныеИзСтроки(Message);
OPI_TCP.SendBinaryData(Connection, Data);
// End of message marker to avoid waiting for the end of timeout
Marker = Chars.LF;
Result = OPI_TCP.ReadBinaryData(Connection, , Marker);
// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
OPI_TCP.CloseConnection(Connection);
```