240 lines
12 KiB
XML
240 lines
12 KiB
XML
<?xml version="1.0" encoding="utf-8" ?>
|
||
<docs>
|
||
<NET>
|
||
<m n="Close">
|
||
<summary>Закрыть подключение.</summary>
|
||
</m>
|
||
<m n="Code">
|
||
<summary>Коды для работы с СТП.</summary>
|
||
</m>
|
||
<m n="Connect">
|
||
<summary>Открытие соединения к серверу.</summary>
|
||
<remarks>Информирует только о подключении к серверу. Исключения опускает.</remarks>
|
||
<returns>Состояние подключения.</returns>
|
||
</m>
|
||
<m n="Connected">
|
||
<summary>Проверка подключения.</summary>
|
||
<returns>Состояние подключения.</returns>
|
||
</m>
|
||
<m n="CreateCode">
|
||
<summary>Формирование массива байт на отправку.</summary>
|
||
<param name="code">Код комманды. Конвертируется в 4 байта. (0x00 0x00 0x00 0x00)</param>
|
||
<param name="val">Передаваемая строка.</param>
|
||
<param name="prefix">Байты перед передаваемой строкой.</param>
|
||
<param name="postfix">Байты после передаваемой строкой.</param>
|
||
<returns>Массив байт для отправки на СТП.</returns>
|
||
</m>
|
||
<m n="Full_Download">
|
||
<summary>Получение файла данных (байтами) с СТП.</summary>
|
||
<param name="date">Дата. Из неё формируется строка в формате YYYMMDD.</param>
|
||
<param name="vdp">Номер печи. 00 - общецеховые параметры.</param>
|
||
<param name="idx">Индекс файла. От 0 до 15.</param>
|
||
<remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks>
|
||
<returns>Обработанный массив байт.</returns>
|
||
<exception cref="ArgumentException">
|
||
Неверный код, для получения файла.
|
||
Неверный флаг во время получения файла.
|
||
</exception>
|
||
<exception cref="IOException">
|
||
Предыдущий запрос не закончен.
|
||
Поток недоступен для записи.
|
||
</exception>
|
||
<exception cref="InvalidOperationException">
|
||
Не получилось соединиться с сервером.
|
||
</exception>
|
||
</m>
|
||
<m n="Full_Download_NH">
|
||
<summary>Получение файла данных (байтами) с СТП.</summary>
|
||
<param name="date">Дата. Из неё формируется строка в формате YYYMMDD.</param>
|
||
<param name="vdp">Номер печи. 00 - общецеховые параметры.</param>
|
||
<param name="idx">Индекс файла. От 0 до 15.</param>
|
||
<remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks>
|
||
<returns>Обработанный массив байт.</returns>
|
||
<exception cref="ArgumentException">
|
||
Неверный код, для получения файла.
|
||
Неверный флаг во время получения файла.
|
||
</exception>
|
||
<exception cref="IOException">
|
||
Предыдущий запрос не закончен.
|
||
Поток недоступен для записи.
|
||
</exception>
|
||
<exception cref="InvalidOperationException">
|
||
Не получилось соединиться с сервером.
|
||
</exception>
|
||
</m>
|
||
<m n="GetFile">
|
||
<summary>Внутренняя функция получения файлов.</summary>
|
||
<param name="code">Код, который будет отправлен на сервер.</param>
|
||
<param name="date">Дата. Из неё формируется строка в формате YYYMMDD.</param>
|
||
<param name="vdp">Номер печи. 00 - общецеховые параметры.</param>
|
||
<param name="idx">Индекс файла. От 0 до 15.</param>
|
||
<returns>Массив байт, соответствующий запрашиваемому файлу.</returns>
|
||
<exception cref="ArgumentException">
|
||
Неверный код, для получения файла.
|
||
Неверный флаг во время получения файла.
|
||
</exception>
|
||
<exception cref="IOException">
|
||
Предыдущий запрос не закончен.
|
||
Поток недоступен для записи.
|
||
</exception>
|
||
<exception cref="InvalidOperationException">
|
||
Не получилось соединиться с сервером.
|
||
</exception>
|
||
|
||
</m>
|
||
<m n="Ip">
|
||
<summary>IP адрес СТП.</summary>
|
||
</m>
|
||
<m n="My_Close">
|
||
<summary>Внетренняя функция для закрытия соединения.</summary>
|
||
<param name="needClose">Флаг о необходимости закрыть соединение.</param>
|
||
</m>
|
||
<m n="My_Connect">
|
||
<summary>Внутренняя функция для создания подключения.</summary>
|
||
<returns>Возвращает флаг необходимости закрытия соединения.</returns>
|
||
<exception cref="InvalidOperationException">
|
||
Не получилось соединиться с сервером.
|
||
</exception>
|
||
</m>
|
||
<m n="NETClient1">
|
||
<summary>Основной конструктор класса NetClient. Ip-адрес - 127.0.0.1; Порт - 1070;</summary>
|
||
</m>
|
||
<m n="NETClient2">
|
||
<summary>Конструктор класса NetClient с параметрами.</summary>
|
||
<param name="ip">Ip-адрес сервера.</param>
|
||
<param name="port">Порт сервера.</param>
|
||
</m>
|
||
<m n="Port">
|
||
<summary>Порт СТП.</summary>
|
||
</m>
|
||
<m n="ReceiveBytes1">
|
||
<summary>Получение неизвестного количество байт.</summary>
|
||
<remarks>Возвращает null, если что-то пошло не так.</remarks>
|
||
<returns>Массив байт.</returns>
|
||
</m>
|
||
<m n="ReceiveBytes2">
|
||
<summary>Получение определенного количество байт.</summary>
|
||
<param name="size">Количество байт.</param>
|
||
<remarks>Возвращает null, если что-то пошло не так.</remarks>
|
||
<returns>Массив байт определенного размера. Может массив быть меньше, если в буфере не будет достаточно данных.</returns>
|
||
</m>
|
||
<m n="ReceiveBytesFixSize">
|
||
<summary>Получение определенного количество байт с сервера.</summary>
|
||
<param name="ns">Открытый сетевой поток.</param>
|
||
<param name="size">Кол-во получаемых байт.</param>
|
||
<param name="awaitInterval">Время ожидания между проверками буфера.</param>
|
||
<param name="tryCounts">Количество проверок буфера.</param>
|
||
<returns>Массив байт. Может быть меньше заданного количества.</returns>
|
||
<exception cref="ArgumentException">
|
||
Размер байт не должен равняться нулю.
|
||
</exception>
|
||
<exception cref="IOException">
|
||
Стрим недоступен для записи.
|
||
</exception>
|
||
<exception cref="TimeoutException">
|
||
Сервер сбросил соединение.
|
||
</exception>
|
||
</m>
|
||
<m n="ReceiveBytesFull">
|
||
<summary>Получение неопределенного количество байт с сервера. Количество ограничено максимальным значением типа UInt.</summary>
|
||
<param name="ns">Открытый сетевой поток.</param>
|
||
<param name="awaitInterval">Время ожидания между проверками буфера.</param>
|
||
<param name="tryCounts">Количество проверок буфера.</param>
|
||
<returns>Массив байт.</returns>
|
||
<exception cref="InvalidOperationException">
|
||
Соединение с сервером закрыто.
|
||
</exception>
|
||
<exception cref="IOException">
|
||
Стрим недоступен для Чтения.
|
||
</exception>
|
||
<exception cref="TimeoutException">
|
||
Сервер сбросил соединение.
|
||
</exception>
|
||
</m>
|
||
<m n="RetryCount">
|
||
<summary>Количество попыток переподключения.</summary>
|
||
</m>
|
||
<m n="RetryInterval">
|
||
<summary>Время в секундах между попытками переподключения.</summary>
|
||
</m>
|
||
<m n="SendBytes1">
|
||
<summary>Отправка массива байт на СТП.</summary>
|
||
<param name="ns">Открытый сетевой поток.</param>
|
||
<param name="arr">Массив байт.</param>
|
||
<returns>Результат отправки.</returns>
|
||
<exception cref="ArgumentException">
|
||
Размер байт не должен равняться нулю.
|
||
</exception>
|
||
<exception cref="IOException">
|
||
Стрим недоступен для записи.
|
||
</exception>
|
||
</m>
|
||
<m n="SendBytes2">
|
||
<summary>Отправка массива байт на СТП.</summary>
|
||
<param name="send">Массив байт для отправки.</param>
|
||
<returns>Результат отправки.</returns>
|
||
<exception cref="ArgumentException">
|
||
Размер байт не должен равняться нулю.
|
||
</exception>
|
||
<exception cref="IOException">
|
||
Поток недоступен для записи.
|
||
</exception>
|
||
</m>
|
||
<m n="Status">
|
||
<summary>
|
||
Статус процесса выполнения запроса.
|
||
Предполагается использовать только на больших
|
||
загрузках и в ассинхронных задачах
|
||
</summary>
|
||
</m>
|
||
<m n="Full_By_Name">
|
||
<summary>Получение файла данных (байтами) с СТП.</summary>
|
||
<param name="val">Название команды.</param>
|
||
<remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks>
|
||
<returns>Массив байт, соответствующий этой команде. Может вернуть null.</returns>
|
||
<exception cref="ArgumentException">
|
||
Неверный флаг во время получения файла.
|
||
</exception>
|
||
<exception cref="IOException">
|
||
Предыдущий запрос не закончен.
|
||
Поток недоступен для записи.
|
||
</exception>
|
||
<exception cref="InvalidOperationException">
|
||
Не получилось соединиться с сервером.
|
||
</exception>
|
||
</m>
|
||
|
||
<m n="Full_Dir_Browse">
|
||
<summary>Получение структуры файлов и папок в запрашиваемой директории.</summary>
|
||
<param name="dir">Путь, структуру которого надо отобразить.</param>
|
||
<remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks>
|
||
<returns>Массив строк. Полные пути к файлам и папкам. Может вернуть null.</returns>
|
||
<exception cref="ArgumentException">
|
||
Неверный флаг окончания строки.
|
||
Неверный флаг во время получения файла.
|
||
</exception>
|
||
<exception cref="IOException">
|
||
Предыдущий запрос не закончен.
|
||
Поток недоступен для записи.
|
||
</exception>
|
||
<exception cref="InvalidOperationException">
|
||
Не получилось соединиться с сервером.
|
||
</exception>
|
||
</m>
|
||
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
<m n=""></m>
|
||
</NET>
|
||
</docs> |