You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2026-05-16 09:38:28 +02:00
Vitaly the Alpaca (bot)
83 lines
2.7 KiB
Plaintext
Vendored
83 lines
2.7 KiB
Plaintext
Vendored
---
|
|
sidebar_position: 3
|
|
sidebar_class_name: doc-no-cli
|
|
description: Read binary data and other functions to work with TCP in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
|
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, TCP]
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
import Admonition from '@theme/Admonition';
|
|
|
|
# Read binary data
|
|
Reads data from the specified connection
|
|
|
|
|
|
|
|
<Tabs>
|
|
<TabItem value="params" label="Parameters" default>
|
|
|
|
`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 |
|
|
|
|
|
|
<div className="return-value-note">
|
|
<div className="return-value-note__title">Returns</div>
|
|
<div className="return-value-note__value">
|
|
BinaryData - Received data
|
|
</div>
|
|
</div>
|
|
|
|
</TabItem>
|
|
<TabItem value="extended" label={<span>Advanced call{' '}<a href="/docs/Start/Advanced-call" target="_blank" rel="noreferrer" title="About advanced call" onClick={(e) => e.stopPropagation()}>?</a></span>}>
|
|
|
|
*This method has no additional advanced call parameters.*
|
|
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
:::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
|
|
:::
|
|
|
|
<Admonition type="caution" title="Caution" className="nocli-admonition">
|
|
<div className="addin">
|
|
<strong>NOCLI:</strong> this method is not available in CLI version
|
|
</div>
|
|
</Admonition>
|
|
|
|
|
|
```bsl title="1C:Enterprise/OneScript code example"
|
|
Address = "45.79.112.203:4242";
|
|
Connection = OPI_TCP.CreateConnection(Address);
|
|
Message = "Hello server!" + Chars.LF;
|
|
Data = GetBinaryDataFromString(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);
|
|
```
|
|
|
|
|
|
|
|
|
|
```json title="Result"
|
|
"Hello server!\n"
|
|
```
|