You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-12-01 22:29:52 +02:00
42 lines
4.0 KiB
Markdown
Vendored
42 lines
4.0 KiB
Markdown
Vendored
---
|
|
id: TCP
|
|
sidebar_class_name: TCP
|
|
---
|
|
|
|
<img src={require('../../static/img/APIs/TCP.png').default} width='64px' />
|
|
|
|
# TCP (Клиент)
|
|
|
|
|
|
|
|
Этот раздел посвящен библиотеке для работы с протоколом TCP. На данной странице описаны все действия, необходимые для полноценного начала работы
|
|
|
|
<div class="theme-admonition theme-admonition-info admonition_node_modules-@docusaurus-theme-classic-lib-theme-Admonition-Layout-styles-module alert alert--info">
|
|
|
|
<img src={require('../../static/img/addin.png').default} class="tipimage" />
|
|
<div class="addin">Для реализации некоторых функции в этой библиотеке используется внешняя компонента <br/>
|
|
Пожалуйста, ознакомьтесь с разделом ["О внешних компонентах"](/docs/Start/Component-requirements) перед началом работы</div>
|
|
</div>
|
|
|
|
|
|
<div class="theme-admonition theme-admonition-caution admonition_node_modules-@docusaurus-theme-classic-lib-theme-Admonition-Layout-styles-module alert alert--warning">
|
|
|
|
<img src={require('../../static/img/lock.png').default} class="tipimage" />
|
|
<div class="addin">Для работы этой библиотеки на Linux необходим **OpenSSL 3.x** <br/>
|
|
Узнать больше: <a href="/docs/Start/Component-requirements#openssl" class="orangelink">"Об использовании OpenSSL во внешних компонентах"</a></div>
|
|
</div>
|
|
|
|
## О реализованных методах
|
|
|
|
Данная библиотека предоставляет несколько готовых методов для работы в качестве TCP клиента. Стандартная схема взаимодействия с сервером выглядит следующим образом:
|
|
|
|
1. Создание объекта и подключение к серверу производится при помощи функции `ОткрытьСоединение`. Туда передается строка подключения в формате `<адрес>:<порт>`
|
|
2. При необходимости, серверу можно отправить сообщение при помощи функций `ОтправитьДвоичныеДанные` и `ОтправитСтроку`
|
|
3. Для получения данных от сервера, используются функции `ПрочитатьДвоичныеДанные` и `ПрочитатьСтроку`. Они имеют различные параметры для ограничения получаемых данных по размеру, маркеру и ожиданию ввода (таймауту)
|
|
4. При окончании работы желательно явно завершать соединение при помощи функции `ЗакрытьСоединение`
|
|
|
|
Для простого сценария со стандартными настройками, также существует функция `ОбработатьЗапрос` - она отправляет данные на указанный адрес и ждет ответа, завершая чтение при нахождении стандартного маркера `\\n`. Также это единственная функция, которая доступна в CLI версии ОПИ
|
|
|
|
## Совместимость
|
|
|
|
Технически, реализация клиента представляет из себя Native компоненту на Rust. Она поставляется в формате zip-архива, и, теоретически, должна работать на всех доступных платформах: x86 и x64 Windows и Linux. Фактическое тестирование проводилось на Windows x64 и, косвенно (через OneScript), на Linux x64 |