ASCU_ALL/DataClient/DataClient.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>DataClient</name>
    </assembly>
    <members>
        <member name="T:DataClient.NETClient">
            <summary>Класс для связи с СТП сервером по проботоколу TCP.</summary>
        </member>
        <member name="P:DataClient.NETClient.Status">
            <summary>
				Статус процесса выполнения запроса.
				Предполагается использовать только на больших
				загрузках и в ассинхронных задачах
			</summary>
        </member>
        <member name="T:DataClient.NETClient.Code">
            <summary>Коды для работы с СТП.</summary>
        </member>
        <member name="F:DataClient.NETClient.Code.version">
            <summary>Версия.</summary>
        </member>
        <member name="F:DataClient.NETClient.Code.download">
            <summary>Загрузка.</summary>
        </member>
        <member name="F:DataClient.NETClient.Code.pasp_download">
            <summary>Загрузка паспорта.</summary>
        </member>
        <member name="F:DataClient.NETClient.Code.server_time">
            <summary>Время сервера.</summary>
        </member>
        <member name="F:DataClient.NETClient.Code.keep_alive">
            <summary>Оставаться на связи.</summary>
        </member>
        <member name="F:DataClient.NETClient.Code.download_nh">
            <summary>Загрузка (nh).</summary>
        </member>
        <member name="F:DataClient.NETClient.Code.dir_browse">
            <summary>Структура директории.</summary>
        </member>
        <member name="F:DataClient.NETClient.Code.by_name">
            <summary>Поиск команды по имени.</summary>
        </member>
        <member name="P:DataClient.NETClient.Ip">
            <summary>IP адрес СТП.</summary>
        </member>
        <member name="P:DataClient.NETClient.Port">
            <summary>Порт СТП.</summary>
        </member>
        <member name="P:DataClient.NETClient.RetryCount">
            <summary>Количество попыток переподключения.</summary>
        </member>
        <member name="P:DataClient.NETClient.RetryInterval">
            <summary>Время в секундах между попытками переподключения.</summary>
        </member>
        <member name="M:DataClient.NETClient.#ctor">
            <summary>Основной конструктор класса NetClient. Ip-адрес - 127.0.0.1; Порт - 1070;</summary>
        </member>
        <member name="M:DataClient.NETClient.#ctor(System.String,System.Int32)">
            <summary>Конструктор класса NetClient с параметрами.</summary><param name="ip">Ip-адрес сервера.</param><param name="port">Порт сервера.</param>
        </member>
        <member name="M:DataClient.NETClient.ReceiveBytesFull(System.Net.Sockets.NetworkStream)">
            <summary>Получение неопределенного количество байт с сервера. Количество ограничено максимальным значением типа UInt.</summary><param name="ns">Открытый сетевой поток.</param><returns>Массив байт.</returns><exception cref="T:System.InvalidOperationException">
				Соединение с сервером закрыто.
			</exception><exception cref="T:System.IO.IOException">
				Стрим недоступен для Чтения.
			</exception><exception cref="T:System.TimeoutException">
				Сервер сбросил соединение.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.ReceiveBytesFixSize(System.Net.Sockets.NetworkStream,System.UInt32)">
            <summary>Получение определенного количество байт с сервера.</summary><param name="ns">Открытый сетевой поток.</param><param name="size">Кол-во получаемых байт.</param><returns>Массив байт. Может быть меньше заданного количества.</returns><exception cref="T:System.ArgumentException">
				Размер байт не должен равняться нулю.
			</exception><exception cref="T:System.IO.IOException">
				Стрим недоступен для записи.
			</exception><exception cref="T:System.TimeoutException">
				Сервер сбросил соединение.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.SendBytes(System.Net.Sockets.NetworkStream,System.Byte[])">
            <summary>Отправка массива байт на СТП.</summary><param name="ns">Открытый сетевой поток.</param><param name="arr">Массив байт.</param><returns>Результат отправки.</returns><exception cref="T:System.ArgumentException">
				Размер байт не должен равняться нулю.
			</exception><exception cref="T:System.IO.IOException">
				Стрим недоступен для записи.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.CreateCode(System.UInt32,System.String,System.Byte[],System.Byte[])">
            <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>
        </member>
        <member name="M:DataClient.NETClient.Connect">
            <summary>Открытие соединения к серверу.</summary><remarks>Информирует только о подключении к серверу. Исключения опускает.</remarks><returns>Состояние подключения.</returns>
        </member>
        <member name="M:DataClient.NETClient.Connected">
            <summary>Проверка подключения.</summary><returns>Состояние подключения.</returns>
        </member>
        <member name="M:DataClient.NETClient.Close">
            <summary>Закрыть подключение.</summary>
        </member>
        <member name="M:DataClient.NETClient.SendBytes(System.Byte[])">
            <summary>Отправка массива байт на СТП.</summary><param name="send">Массив байт для отправки.</param><returns>Результат отправки.</returns><exception cref="T:System.ArgumentException">
				Размер байт не должен равняться нулю.
			</exception><exception cref="T:System.IO.IOException">
				Поток недоступен для записи.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.ReceiveBytes">
            <summary>Получение неизвестного количество байт.</summary><remarks>Возвращает null, если что-то пошло не так.</remarks><returns>Массив байт.</returns>
        </member>
        <member name="M:DataClient.NETClient.ReceiveBytes(System.UInt32)">
            <summary>Получение определенного количество байт.</summary><param name="size">Количество байт.</param><remarks>Возвращает null, если что-то пошло не так.</remarks><returns>Массив байт определенного размера. Может массив быть меньше, если в буфере не будет достаточно данных.</returns>
        </member>
        <member name="M:DataClient.NETClient.My_Connect">
            <summary>Внутренняя функция для создания подключения.</summary><returns>Возвращает флаг необходимости закрытия соединения.</returns><exception cref="T:System.InvalidOperationException">
				Не получилось соединиться с сервером.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.My_Close(System.Boolean)">
            <summary>Внетренняя функция для закрытия соединения.</summary><param name="needClose">Флаг о необходимости закрыть соединение.</param>
        </member>
        <member name="M:DataClient.NETClient.GetFile(DataClient.NETClient.Code,System.DateTime,System.Int32,System.Int32)">
            <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="T:System.ArgumentException">
				Неверный код, для получения файла.
				Неверный флаг во время получения файла.
			</exception><exception cref="T:System.IO.IOException">
				Предыдущий запрос не закончен.
				Поток недоступен для записи.
			</exception><exception cref="T:System.InvalidOperationException">
				Не получилось соединиться с сервером.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.Full_Download_NH(System.DateTime,System.Int32,System.Int32)">
            <summary>Получение файла данных (байтами) с СТП.</summary><param name="date">Дата. Из неё формируется строка в формате YYYMMDD.</param><param name="vdp">Номер печи. 00 - общецеховые параметры.</param><param name="idx">Индекс файла. От 0 до 15.</param><remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks><returns>Обработанный массив байт.</returns><exception cref="T:System.ArgumentException">
				Неверный код, для получения файла.
				Неверный флаг во время получения файла.
			</exception><exception cref="T:System.IO.IOException">
				Предыдущий запрос не закончен.
				Поток недоступен для записи.
			</exception><exception cref="T:System.InvalidOperationException">
				Не получилось соединиться с сервером.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.Full_Download(System.DateTime,System.Int32,System.Int32)">
            <summary>Получение файла данных (байтами) с СТП.</summary><param name="date">Дата. Из неё формируется строка в формате YYYMMDD.</param><param name="vdp">Номер печи. 00 - общецеховые параметры.</param><param name="idx">Индекс файла. От 0 до 15.</param><remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks><returns>Обработанный массив байт.</returns><exception cref="T:System.ArgumentException">
				Неверный код, для получения файла.
				Неверный флаг во время получения файла.
			</exception><exception cref="T:System.IO.IOException">
				Предыдущий запрос не закончен.
				Поток недоступен для записи.
			</exception><exception cref="T:System.InvalidOperationException">
				Не получилось соединиться с сервером.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.Full_By_Name(System.String)">
            <summary>Получение файла данных (байтами) с СТП.</summary><param name="val">Название команды.</param><remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks><returns>Массив байт, соответствующий этой команде. Может вернуть null.</returns><exception cref="T:System.ArgumentException">
				Неверный флаг во время получения файла.
			</exception><exception cref="T:System.IO.IOException">
				Предыдущий запрос не закончен.
				Поток недоступен для записи.
			</exception><exception cref="T:System.InvalidOperationException">
				Не получилось соединиться с сервером.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.Full_Dir_Browse(System.String)">
            <summary>Получение структуры файлов и папок в запрашиваемой директории.</summary><param name="dir">Путь, структуру которого надо отобразить.</param><remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks><returns>Массив строк. Полные пути к файлам и папкам. Может вернуть null.</returns><exception cref="T:System.ArgumentException">
				Неверный флаг окончания строки.
				Неверный флаг во время получения файла.
			</exception><exception cref="T:System.IO.IOException">
				Предыдущий запрос не закончен.
				Поток недоступен для записи.
			</exception><exception cref="T:System.InvalidOperationException">
				Не получилось соединиться с сервером.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.Full_Server_Time">
            <summary>Получение текущее время на сервере.</summary><remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks><returns>Текущее время на сервере.</returns><exception cref="T:System.ArgumentException">
				Неверный флаг окончания строки.
				Неверный флаг во время получения файла.
			</exception><exception cref="T:System.IO.IOException">
				Предыдущий запрос не закончен.
				Поток недоступен для записи.
			</exception><exception cref="T:System.InvalidOperationException">
				Не получилось соединиться с сервером.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.Full_Version">
            <summary>Получение текущую версию сервера.</summary><remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks><returns>строку с названием версии сервера.</returns><exception cref="T:System.ArgumentException">
				Неверный флаг окончания строки.
				Неверный флаг во время получения файла.
			</exception><exception cref="T:System.IO.IOException">
				Предыдущий запрос не закончен.
				Поток недоступен для записи.
			</exception><exception cref="T:System.InvalidOperationException">
				Не получилось соединиться с сервером.
			</exception>
        </member>
        <member name="M:DataClient.NETClient.Full_Keep_Alive">
            <summary>Отправка команды для поддержания соединения.</summary><remarks>Выполняет автоподключение, если оно не установлено. Не все ошибки описаны в документации.</remarks><exception cref="T:System.IO.IOException">
				Предыдущий запрос не закончен.
				Поток недоступен для записи.
			</exception><exception cref="T:System.InvalidOperationException">
				Не получилось соединиться с сервером.
			</exception>
        </member>
        <member name="T:DataClient.STPClient">
            <summary>Класс для связи с СТП. Содержит все инструменты, для получения данных.</summary>
        </member>
        <member name="M:DataClient.STPClient.Config">
            <summary>Чтение конфигурационнного файла и установка параметров по умолчанию.</summary>
        </member>
        <member name="P:DataClient.STPClient.UseServer">
            <summary>Номер сервера, используемого по умолчанию.</summary>
        </member>
        <member name="P:DataClient.STPClient.ListServers">
            <summary>Массив серверов, инициализированных в экземпляре класса.</summary>
        </member>
        <member name="P:DataClient.STPClient.Server">
            <summary> Текущий рабочий сервер </summary>
        </member>
        <member name="M:DataClient.STPClient.CheckDataServer(System.String,System.Int32,System.String)">
            <summary>
            Проверка параметров сервера.
            </summary>
            <param name="ip">Ip адрес сервера СТП.</param>
            <param name="port">Порт сервера СТП.</param>
            <param name="dir">Путь к архивным данным.</param>
            <returns>Результат проверки.</returns>
        </member>
        <member name="M:DataClient.STPClient.AddServer(System.String,System.String,System.Int32,System.String)">
            <summary>Добавление сервера в список серверов.</summary>
            <param name="name">Название сервера</param>
            <param name="ip">IP адресс сервера.</param>
            <param name="port">Порт сервера.</param>
            <param name="dir">Путь к архиву.</param>
            <returns>Результат выполнения функции.</returns>
        </member>
        <member name="M:DataClient.STPClient.RemoveServer(System.Int32)">
            <summary>Удаление сервера из списка серверов по его номеру.</summary>
            <param name="id">Номер сервера в списке серверов.</param>
            <returns>Результат выполнения функции.</returns>
        </member>
        <member name="M:DataClient.STPClient.#ctor">
            <summary>Создание экземпляра класса.</summary>
        </member>
        <member name="M:DataClient.STPClient.#ctor(System.String)">
            <summary>Создание экземпляра класса с указанием конфигурационного файла.</summary>
            <param name="confDir">Путь к файлу конфигурации.</param>
        </member>
    </members>
</doc>