matlab.net.http.io. Класс FileProvider

Пакет: matlab.net.http.io
Суперклассы: matlab.net.http.io.ContentProvider, matlab.mixin.Copyable

ContentProvider, чтобы отправить файлы

Описание

Используйте объект FileProvider в качестве удобного способа отправить один или несколько файлов в сервер.

Класс matlab.net.http.io.FileProvider является классом handle.

Создание

Описание

providers = FileProvider(files) создает массив FileProviders, один для каждого файла в массиве files. Каждая запись отправляет один файл в сервер.

Чтобы отключить передачу файлов прежде, чем достигнуть конца файла, установите свойство FileSize на количество желаемых байтов. Чтобы решить, где закончить передачу на основе содержимого файла, в то время как она читается, запишите подкласс и замените getData, чтобы исследовать считанные данные и установить возвращаемое значение stop заканчивать передачу.

providers = FileProvider(files,permission,machineformat,encoding) задает опции для открытия файлов.

providers = FileProvider(fileIds) построения FileProviders заданы идентификаторами файла. Файлы читаются, начиная в текущем индикаторе позиции в файле в конец файла. Идентификаторы файла не закрываются, когда передача завершена. Этот метод полезен, если файл уже открыт, или когда это необходимо передавать только запаздывающую часть файла. Для этого откройте файл, установите индикатор позиции в файле на запуск данных в файле, который вы хотите передать, и затем передать тот идентификатор файла в этого конструктора. Можно также установить FileSize ограничивать общее количество байтов или писать подкласс, чтобы управлять, когда закончить передачу.

Входные параметры

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

Одни или несколько имен файлов, заданных как строка, массив строк, вектор символов или массив ячеек из символьных векторов. Для получения дополнительной информации об использовании имен файлов, смотрите fopen.

Типы данных: char | string

Тип доступа к файлу, заданный как строка. Если permission задан, он должен позволить доступ для записи. Значением по умолчанию является 'w+', который открывает или создает файл для чтения и записи и отбрасывает существующее содержимое, если таковые имеются.

Типы данных: char | string

Порядок для чтения или записи байтов или битов, заданных как любое значение, позволен функцией fopen.

Типы данных: char | string

Кодировка символов, заданная как любое значение, позволена функцией fopen.

Типы данных: char | string

Один или несколько идентификаторов файла, заданных как двойное или массив дважды.

Свойства

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

Общественные собственности

Полный путь файла, выведенного от входного параметра, заданного как строка.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Зависимый

tRUE

Количество байтов, чтобы передать, заданный как дважды.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Запросите сообщение отправить, заданный как объект matlab.net.http.RequestMessage.

Это свойство используется только авторами подкласса. RequestMessage.send и методы RequestMessage.complete устанавливают это свойство на RequestMessage, в Body которого этот провайдер был помещен, прежде, чем вызвать любые другие методы в этом провайдере, и прежде, чем добавить любые дополнительные поля заголовка или подтвердить сообщение. Провайдер может исследовать это сообщение, чтобы видеть то, что содержалось в исходном запросе.

Делегаты видят то же значение для этого свойства как delegator. ContentProviders должен иметь в виду, что, если они - делегаты, они не обязательно обеспечивают целое тело сообщения запроса, таким образом, они не должны принимать, что поля заголовка в этом Запросе являются подходящими для данных, которые они обеспечивают. Обычно, делегаты должны проигнорировать поля заголовка в этом запросе, относящемся к данным, такие как Тип контента.

Если провайдер хочет добавить какие-либо поля заголовка в это сообщение или изменить существующие единицы, это должно сделать так в его методе complete путем добавления тех полей в свойство Header. Вызывающая сторона complete (RequestMessage или провайдер делегирования) определяет, что сделать с теми полями. RequestMessage.send и RequestMessage.complete всегда копируют эти поля в Header RequestMessage. Провайдер делегирования может скопировать поля в свое собственное свойство Header или вставить их в сообщение (как в случае MultipartProvider). Для получения дополнительной информации смотрите свойство Header.

Это свойство доступно только для чтения.

Атрибуты:

GetAccesspublic
SetAccessmatlab.net.http.RequestMessage

Поля заголовка сообщения или части, заданной как вектор одного или нескольких объектов matlab.net.http.HeaderField.

Это свойство только используется авторами подкласса. MATLAB® устанавливает это свойство прежде, чем вызвать метод complete провайдера. Для немногослойных сообщений MATLAB инициализирует это свойство к содержимому Request.Header минус любой matlab.net.http.field.GenericFields или поля с пустым знаком. ContentProvider использует это свойство добавить поля заголовка, которые описывают данные, которые будут отправлены или добавят параметры в поля заголовка уже в сообщении. В делегате к MultipartProvider MATLAB инициализирует это свойство к полям заголовка, которые провайдер делегирования намеревается вставить для части. Делегаты могут изменить или изменить эти поля.

По возврату из метода complete провайдера, если это не многослойное сообщение, то MATLAB читает это свойство и объединяет его содержимое в заголовок Request. Поля в этом Header с Names, которые уже не появляются в Request.Header, добавляются в конец Request.Header. Если поле в этом Header имеет Name, который эквивалентен один в Request.Header, и у обоих есть непустой Values, то:

  • Если тем в Request.Header является GenericField, то проигнорируйте тот в Header.

  • Если тем в Request.Header не является GenericField, то замените его на тот в Header.

Если один или оба из них имеет пустой Value, то поле удалено из Request.Header, и это не добавляется как часть нормального завершения сообщения.

Если это - делегат MultipartProvider, то целое содержимое этого Header используется в качестве заголовка части. Многослойные делегаты не должны принимать, что Request.Header содержит любые поля, имеющие отношение к их собственному Header. Провайдер может определить, является ли это многослойным делегатом путем проверки, является ли MyDelegator MultipartProvider, хотя этот тест вряд ли будет необходим.

MATLAB читает это свойство только по возврату из вызова метода complete провайдера. Изменения в этом массиве проигнорированы, если MATLAB вызывает start.

Авторы класса должны иметь в виду, что их подклассы могут добавить поля в этот Header (в их методе complete) прежде, чем вызвать complete в их суперклассе. Лучше сохранять такие поля а не добавлять поля с теми же именами. Однако добавление параметра к полю допустимо. Например, суперкласс может добавить параметр набора символов в существующее поле Content-Type, которое уже не имеет того.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Укажите, обеспечить ли разделенное на блоки кодирование передачи, заданное как булевская переменная. Это свойство представляет интерес только, чтобы разделить авторов на подклассы и применимо только к провайдерам, которые не являются многослойными делегатами. Подклассы устанавливают ForceChunked управлять, должно ли содержимое быть отправлено с помощью разделенного на блоки кодирования передачи. Если false (значение по умолчанию), MATLAB решает, отправить ли разделенное на блоки содержимое, на основе того, знает ли это длину содержимого в то время, когда сообщение готово быть отправленным:

  • Если MATLAB знает длину содержимого (который имеет место, если сообщение содержит поле Content-Length, или если метод expectedContentLength этого провайдера возвратил номер), то MATLAB решает, отправить ли разделенный на блоки или нет.

  • Если MATLAB не знает длины содержимого (никакое поле Content-Length в заголовке и expectedContentLength, возвращенном пустой), то MATLAB всегда отправляет разделенное на блоки сообщение.

Если ForceChunked является true, то MATLAB отправляет сообщение, разделенное на блоки независимо от того, знает ли это длину содержимого, если известная длина не меньше, чем размер фрагмента. Если этим свойством является true, то сообщение не должно содержать поле Content-Length, потому что HTTP не позволяет разделенному на блоки сообщению иметь поле Content-Length. Однако можно все еще возвратить ненулевое значение в методе expectedContentLength, если вы хотите, чтобы MATLAB проверил, что вы возвращаете ожидаемую длину данных.

Когда MATLAB принимает решение отправить разделенное на блоки сообщение, размер каждого фрагмента равен длине данных, возвращенных getData.

MATLAB читает это значение после вызова метода complete, прежде, чем вызвать start. Это не устанавливает это поле.

Атрибуты:

GetAccess

общественность

SetAccess

общественность

Защищенные свойства

ContentProvider, к которому этот провайдер делегирует, заданный как объект matlab.net.http.io.ContentProvider. Это свойство собирается в провайдере вызова (delegator) методом delegateTo указать на текущего делегированного провайдера. Если нет никакой текущей делегации, то значение пусто.

Методы complete устанавливают это свойство опустеть.

Атрибуты:

GetAccess

защищенный

SetAccess

защищенный

ContentProvider, который делегировал к этому провайдеру, заданному как объект matlab.net.http.io.ContentProvider.

Если ContentProvider делегирует ответственность за отправку всех или фрагмента данных о сообщении к другому провайдеру, то это свойство идентифицирует провайдера делегирования делегату. Например, MultipartProvider делегирует части сообщения к другим провайдерам, таким образом, это вставляет указатель на себя в каждом делегате. В противном случае MyDelegator пуст. Метод delegateTo устанавливает это свойство в делегате.

Атрибуты:

GetAccess

защищенный

SetAccess

защищенный

Методы

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

Больше о

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

Введенный в R2018a

Для просмотра документации необходимо авторизоваться на сайте