matlab.net.http.io.MultipartProvider class

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

ContentProvider, чтобы отправить многослойные/смешанные сообщения HTTP

расширьте все на странице

Описание

Этот провайдер помогает с созданием многослойных сообщений HTTP.

Типом контента по умолчанию является "multipart/mixed", и полезная нагрузка сообщения содержит произвольное число частей, каждая часть, содержащая ее собственный заголовок, описывающий ту часть. Для получения дополнительной информации о многослойных сообщениях смотрите RFC 2046, разделите 5.1.

Используйте этого провайдера непосредственно, только если вы знаете, что ваш сервер принимает многослойные/смешанные сообщения. Обычно, серверы, которые принимают многослойные сообщения вместо этого, требуют "multipart/form-data", который реализован подклассом MultipartFormProvider. Можно реализовать другие многослойные типы с помощью подклассов.

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

Разделите авторов на подклассы

Каждая из частей многослойного сообщения может быть задана как данные в любом из форматов, разрешенных для RequestMessage.Body, или как ContentProvider это создает данные. ContentProvider объекты, которые используются к данным по запасам для частей, называются делегатами, в то время как этот MultipartProvider провайдер верхнего уровня. В общем случае любой ContentProvider подходит как делегат. MultipartProvider вызывает каждого делегата в свою очередь, когда сообщение отправляется, вызывая его методы, такие как complete или start, так, чтобы делегат в общем не имел в виду, что это обеспечивает содержимое для части, а не для целого сообщения.

Этот провайдер всегда передает RequestMessage как разделено на блоки, таким образом, это не включает поле заголовка Довольной Длины в сообщение или в заголовки ни одной из частей. В то время как MultipartProvider вызовы expectedContentLength каждого делегата метод прежде, чем отправить часть, это только использует возвращаемое значение (если непустой), чтобы осуществить длину, не создать поле Content-Length. Если делегат действительно хочет, чтобы поле Content-Length появилось в части, это должно вставить такое поле явным образом в его Header свойство. Ни один из ContentProvider подклассы, обеспеченные MATLAB®, делают эту обработку.

Создание

Описание

provider = MultipartProvider(part1,...,partN) создает MultipartProvider это отправляет заданные части, в заданном порядке, в запросе HTTP. По умолчанию этот провайдер устанавливает Тип контента сообщения к "multipart/mixed", но подклассы могут изменить подтип путем установки Subtype свойство. Конструктор устанавливает элементы Parts массив ячеек свойства к каждому part1,...,partN аргумент.

Свойства

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

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

Части текста сообщения в виде массива ячеек одного или нескольких из этих значений:

ContentProvider объект

MultipartProvider создание делегатов части к заданному провайдеру (названный делегатом), вызывая его полный метод, чтобы получить информацию о заголовке о части и его getData метод, чтобы получить данные. Header делегата свойство используется для заголовка части. Любой подкласс ContentProvider может быть задан здесь. Обычно, делегат не задает длину содержимого, ни реализует expectedContentLength метод, поскольку конец части определяется граничной строкой, а не полем заголовка. Если тот метод реализован, чтобы возвратить непустое значение, то значение используется только, чтобы осуществить длину содержимого, не создать поле Content-Length.

RequestMessage объект

MultipartProvider отправляет Header и Body из RequestMessage как часть. Если Payload Тела свойство установлено, затем это используется для необработанной полезной нагрузки. В противном случае Data Тела свойство преобразовано на основе его типа или поля Content-Type в Header, как описано для MessageBody.Data. Эта опция полезна, если у вас есть данные, чтобы отправить и хотеть использовать в своих интересах обработку по умолчанию тех данных, которые MATLAB обычно делает при отправке RequestMessage. Это позволяет вам задавать пользовательские поля заголовка в запросе, который будет использоваться в качестве Header части и управляйте, как данные преобразованы, не имея необходимость писать ContentProvider подкласс. RequestMessage.RequestLine свойство проигнорировано.

MessageBody объект

MessageBody обрабатывается то же самое, как будто это было в RequestMessage это не имело никакого поля Content-Type. Эта опция полезна, если обработка по умолчанию данных на основе его типа достаточна, и вы не должны задавать пользовательские поля заголовка для части. MATLAB вставляет поле Content-Type в часть на основе типа данных. Смотрите MessageBody.Data для правил преобразования.

Массив ContentProvider, RequestMessage, и/или MessageBody объекты

Это обрабатывает каждый элемент массива как часть. Не массив ячеек.

Обработайте к getData метод

Этот метод должен иметь подпись ContentProvider.getData. В этом случае Тип контента части установлен в "application/octet-stream", таким образом, эта опция полезна для отправки двоичных данных. При использовании этой опции вы не можете задать пользовательские поля заголовка для части.

Любой другой тип

Если тип не совпадает ни с одним из этих типов и не является указателем на функцию, то он обработан, как будто он присутствовал в Data свойство MessageBody. См. описание для MessageBody типы.

Атрибуты:

GetAccess
public
SetAccess
public
Dependent
true

Поля заголовка сообщения или части в виде вектора из одного или нескольких 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
public
SetAccess
public

Укажите, обеспечить ли разделенное на блоки кодирование передачи в виде булевской переменной. Это свойство представляет интерес только, чтобы разделить авторов на подклассы и применимо только к провайдерам, которые не являются многослойными делегатами. Подклассы устанавливают 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
public
SetAccess
public

Запросите сообщение отправить в виде 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

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

Подтип провайдера в виде строки. Значение по умолчанию "mixed" добавляет набор заголовка Типа контента к "multipart/mixed" к сообщению, плюс соответствующие параметры. Подклассы могут изменить это значение в конструкторе или complete метод. Это значение появляется в Типе контента после "multipart/".

Атрибуты:

GetAccess
protected
SetAccess
protected

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

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

Атрибуты:

GetAccess
protected
SetAccess
protected

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

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

Атрибуты:

GetAccess
protected
SetAccess
protected

Методы

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

Больше о

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

Смотрите также

| | | |

Введенный в R2018a

Документация MATLAB

Поддержка

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