exponenta event banner

matlab.net.http.ProgressMonitor класс

Пакет: matlab.net.http
Суперклассы: handle

Монитор хода выполнения обмена сообщениями HTTP

Описание

Используйте ProgressMonitor для реализации монитора хода выполнения для сообщения запроса HTTP. Монитор хода выполнения прослушивает изменения в свойствах этого класса, чтобы реализовать отображение или обновление по своему выбору.

Для реализации монитора хода выполнения создайте подкласс этого класса. Затем создайте HTTPOptions укажите этот подкласс в качестве ProgressMonitorFcn и задайте значение UseProgressMonitor свойство для true.

HTTP-запрос запускается при вызове RequestMessage.send способ. Процесс может включать в себя несколько сообщений в обоих направлениях в случае перенаправления и аутентификации. MATLAB ® вызывает done метод после завершения всех передач.

Во время передачи:

  • MATLAB устанавливает Max, CancelFcn, и Direction свойства при вызове RequestMessage.send.

  • MATLAB устанавливает Value повторно, как тело сообщения запроса отправляется для указания количества переданных байтов.

  • При получении ResponseMessage начинается, наборы MATLAB Direction кому Response и снова наборы Value неоднократно.

  • Чтобы отменить передачу в любое время, позвоните по телефону CancelFcn функция. Это действие аналогично прерыванию send в окне команд.

Можно просмотреть графический индикатор хода выполнения или другой индикатор хода выполнения после Direction изменения в Response. Для каждого последующего Value, обновить индикатор до текущего Value. Этот механизм можно также использовать для программного мониторинга хода выполнения.

matlab.net.http.ProgressMonitor класс является handle класс.

Создание

obj = matlab.net.http.ProgressMonitor(Name,Value) создает монитор хода выполнения с дополнительными свойствами, заданными одним или несколькими аргументами пары имя-значение. Name - имя свойства и Value - соответствующее значение. Можно указать несколько аргументов пары имя-значение в любом порядке как Name1,Value1,...,NameN,ValueN. Для неопределенных свойств установлены значения по умолчанию.

Свойства

развернуть все

Секунды до первого вызова и максимальный интервал между вызовами, указанный как двойной.

Interval - время в секундах после начала передачи до первой установки Value собственность. Interval - предлагаемый максимальный промежуток времени между настройками Valueнезависимо от прогресса. Если общее время передачи данных меньше Interval секунды, затем Value не установлен. Если данные не были перенесены в Interval секунд с момента последней установки Value, то Value может быть снова задано такое же значение. Таким образом, ваш ProgressMonitor объект может отменить передачу (путем вызова CancelFcn), даже если прогресса нет.

Interval значение является предлагаемым значением. Нет гарантии, что MATLAB установит Value в Interval секунд, если не было прогресса.

Интервал по умолчанию составляет две секунды. Чтобы указать другое значение, задайте Interval в конструкторе. Минимальный интервал между последовательными настройками Value при отсутствии прогресса составляет 0,1 секунды. Однако, если Value изменения, он может быть установлен чаще, чем этот интервал.

После установки Value первый раз задержка в установке отсутствует Value для последующих сообщений в том же обмене.

Индикатор монитора используется, указан как true или false. MATLAB задает это свойство, чтобы указать, использует ли оно это ProgressMonitor объект во время передачи. InUse запрещает повторное использование этого объекта для нескольких переносов одновременно.

Типы данных: logical

Функция вызова для отмены передачи, указанная как дескриптор функции. Наборы MATLAB CancelFcn в функцию ProgressMonitor должен вызвать для отмены передачи. Вызов этой функции имеет тот же эффект, что и прерывание передачи в окне команд.

Максимальная длина передачи, указанная как uint64. Если максимальная длина неизвестна, Max является []. Max - максимальное значение отображаемого индикатора хода выполнения.

Наборы MATLAB Max в начале каждой операции передачи и приема до ожидаемого количества байтов, подлежащих передаче, на основе поля заголовка Content-Length.

Если сообщение не содержит поля Content-Length, Max является []. В этом случае невозможно определить долю выполненного переноса. Однако можно отслеживать изменения в Value собственность.

Направление передачи, указанное как matlab.net.http.MessageType объект. Наборы MATLAB Direction для указания, отслеживается ли ход выполнения для сообщения запроса или ответного сообщения. Если трансфер не происходит, то Direction пуст.

Количество байт, переданных на данный момент, указанное как uint64. Наборы MATLAB Value многократно до общего количества байтов, переданных для текущего сообщения. Однако он задерживает установку этого свойства первый раз в обмене по крайней мере до Interval с момента начала сообщения прошло несколько секунд.

Реализация set.Value метод для этого свойства для мониторинга хода передачи. Можно также реализовать возможность отмены переноса из монитора хода выполнения в set.Value способ.

MATLAB может быть установлен Value пусто в конце данной передачи, чтобы указать, что передача в текущем направлении закончилась. MATLAB всегда устанавливает Value пусто при завершении всех переводов перед вызовом done способ.

Вы не можете управлять частотой, с которой MATLAB обновляет Value собственность. Однако MATLAB может быть установлен Value не реже одного раза в Interval секунд, даже если прогресса нет. Это поведение позволяет вызывать CancelFcn если передача не выполняется. Value может быть нулевым, если не было передано ни одного байта для Interval секунды с начала передачи.

Методы

развернуть все

Представлен в R2016b