Особенности работы объекта компоненты
- Объект работает в неблокирующем режиме. То есть после вызова любого метода объект сразу возвращает управление основному потоку 1С. Далее объект продолжает выполнение метода в фоновом потоке. Таким образом, объект не зависит от длительных операций основного потока (таких, как формирование отчетов и т.п.).
- Для сигнализации о возникшем событии используется ВнешнееСобытие.
- В 1С может быть одновременно создано несколько объектов TcpClient. Чтобы понять, какому объекту адресовано событие, используется идентификатор <ObjectID>, который передается первым параметром во ВнешнемСобытии.
Свойства объекта
ИдентификаторОбъекта (ObjectID) (чтение/запись)
Тип: Строка
Описание:
Идентификатор, позволяющий отличать один объект компоненты от другого. По умолчанию устанавливается строкой вида TcpClient_NNNNN, где NNNNN - случайное число.
СоединениеУстановлено (Connected)
Тип: Булево
Описание:
Позволяет определить, установлено ли соединение.
Версия (Version)
Тип: Строка
Описание:
Возвращает версию компоненты.
ВерсияOpenSSL (OpenSSLVersion)
Тип: Булево
Описание:
Возвращает версию библиотеки OpenSSL.
Методы объекта
Открыть (Open)
Синтаксис:
Открыть(<Сервер>, <Порт>, <ЗащищенноеСоединение>)
Параметры:
<Сервер> (обязательный)
Тип: Строка
Имя или ip-адрес сервера
<Порт> (обязательный)
Тип: Число
Порт для подключения
<ЗащищенноеСоединение> (необязательный)
Тип: Булево
Использовать защищенное соединение
Описание:
Устанавливает соединение с сервером. При успешном соединении генерируется внешнее событие Open. Если соединение не удалость установить - генерируется внешнее событие Error.
Закрыть (Close)
Синтаксис:
Закрыть()
Описание:
Разрывает соединение с сервером.
Прочитать (Read)
Синтаксис:
Прочитать(<КоличествоБайт>)
Параметры:
<КоличествоБайт> (необяательный)
Тип: Число
Определяет количество байт для чтения.
Возвращаемое значение:
Тип: ДвоичныеДанные
Описание:
Выполняет чтение данных. Метод следует вызывать после получения события "Read".
Записать (Write)
Синтаксис:
Записать(<Данные>)
Параметры:
<Данные> (обязательный)
Тип: ДвоичныеДанные
Описание:
Выполняет запись данных. Метод следует вызывать после получения события "Write".
Внешние события
Объект компоненты генерирует внешние события с параметрами:
- Источник: <ObjectID>
- Событие:
- "Open" - соединение c TCP-сервером установлено
- "Write" - TCP-сервер готов к приёму данных, можно отправить данные методом Write()
- "Read" - от TCP-сервера пришли новые данные, их можно считать методом Read()
- "Close" - соединение закрыто
- "Error" - возникла ошибка
- Данные: Дополнительное описание события (причина закрытия или описание ошибки)