matlab.net.http.io.ContentProvider class

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

ContentProvider для полезных данных HTTP-сообщений

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

Описание

A- ContentProvider предоставляет данные для HTTP- RequestMessage пока сообщение подается. Простой провайдер преобразует данные из MATLAB® введите в байтовый поток. Более сложные провайдеры могут транслировать данные на сервер, получая или генерируя данные одновременно с их отправкой, что избегает необходимости иметь все данные в памяти перед началом сообщения.

Обычно при отправке данных в веб-сервис (обычно в запросе PUT или POST) создается RequestMessage и вставить данные в виде MessageBody объект в RequestMessage.Body свойство. Когда вы отправляете это сообщение с помощью RequestMessage.sendMATLAB преобразует эти данные в байтовый поток, который будет отправлен на сервер, преобразуя его на основе Content-Type сообщения и типа данных в Body.Data. См. MessageBody.Data для этих правил преобразования.

Вместо вставки MessageBody объект в RequestMessage.Body свойство, можно создать ContentProvider объект и вставьте его вместо этого. Затем, когда вы отправляете сообщение, MATLAB вызывает методы в ContentProvider получить буферы данных для отправки во время отправки сообщения.

Вставляете ли вы MessageBody или ContentProvider в сообщение, вызов на RequestMessage.send не возвращается (то есть блокируется) до тех пор, пока не будет отправлено все сообщение и получен ответ, или не произошла ошибка. Но с ContentProviderMATLAB производит периодические коллбэки в провайдер, чтобы получить буферы данных для отправки, во время блокировки отправки. В этих коллбэках, ваши ContentProvider может получить данные из любого источника, такого как файл, массив MATLAB, датчик оборудования, функция MATLAB и т.д. Задачей провайдера является преобразование этих данных в байтовый поток в виде буферов uint8, которые могут быть отправлены в сеть.

ContentProvider - абстрактный класс, предназначенный для авторов классов в подкласс с их собственным генератором данных или конвертером, или можно использовать (или подкласс) один из поставщиков MATLAB, которые генерируют данные для вас из различных источников, не записывая подкласс. Эти провайдеры имеют опции, которые дают вам более гибкий контроль над тем, как данные получаются и преобразуются, по сравнению с автоматическими преобразованиями, которые происходят, когда вы вставляете данные непосредственно в MessageBody. Используйте один из ContentProvider подклассы:

Даже если вам не нужно транслировать данные, использование одного из этих провайдеров может упростить процесс отправки определенных типов содержимого, так как они преобразуют данные из внутренней формы в uint8 поток. Для примера, FormProvider позволяет отправлять ответы форм на сервер, где можно удобно выразить данные как массив QueryParameter объекты. MultipartFormProvider позволяет отправлять отклики многопартичных форм, упрощая создание откликов на многопартичные формы. Использование любых ContentProvider, вам нужно понять тип содержимого, которое сервер ожидает от вас отправить.

The matlab.net.http.io.ContentProvider класс является handle класс.

Авторы подкласса

Самое простое ContentProvider требуется только реализация getData способ обеспечения буферов данных по мере их запроса MATLAB. Чтобы использовать вашего провайдера, вставьте его в Body свойство RequestMessage. В этом примере третий аргумент к RequestMessage конструктор, a MyProvider объект, переходит в Body:

provider = MyProvider;
req = matlab.net.http.RequestMessage('put', headers, provider);
resp = req.send(uri);

Вот пример a MyProvider класс, считываемый из имени файла, переданного в качестве аргумента конструктору и отправляющего его в Интернет. Для хорошей меры мы закрываем файл в конце или когда этот провайдер удаляется.

    classdef MyProvider < matlab.net.http.io.ContentProvider
        properties
            FileID double
        end
 
        methods
            function obj = MyProvider(name)
                obj.FileID = fopen(name);
            end
 
            function [data, stop] = getData(obj, length)
                [data, len] = fread(obj.FileID, length, '*uint8');
                stop = len < length;
                if (stop)
                    fclose(obj.FileID);
                    obj.FileID = [];
                end
            end
 
            function delete(obj)
                if ~isempty(obj.FileID)
                    fclose(obj.FileID);
                    obj.FileID = [];
                end
            end
        end
    end

MATLAB вызывает complete провайдера метод, когда он формирует новое сообщение для отправки. Цель состоит в том, чтобы позволить поставщику подготовиться к новому сообщению и добавить все необходимые поля заголовка к сообщению. MATLAB вызывает start провайдера метод, когда пришло время отправить данные, но перед первым вызовом в getData.

Свойства

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

Общественная собственность

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

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

По возвращении с 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 используется в качестве заголовка детали. Multipart делегаты не должны принимать, что Request.Header содержит любые поля, относящиеся к их собственным Header. Поставщик может определить, является ли он делегатом из нескольких частей, проверяя, является ли MyDelegator является MultipartProviderхотя этот тест вряд ли понадобится.

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

  • Если 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 объект.

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

Делегаты видят то же значение для этого свойства, что и делегат. ContentProviders следует знать, что, если они являются делегатами, они не обязательно предоставляют весь текст сообщения запроса, поэтому они не должны считать, что поля заголовка в этом Запросе имеют отношение к данным, которые они предоставляют. Как правило, делегаты должны игнорировать поля заголовка в этом запросе, относящиеся к данным, например, Content-Type.

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

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

Атрибуты:

GetAccesspublic
SetAccessmatlab.net.http.RequestMessage

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

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

The complete методы задают пустое свойство.

Атрибуты:

GetAccess
protected
SetAccess
protected

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

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

Атрибуты:

GetAccess
protected
SetAccess
protected

Методы

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

Подробнее о

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

См. также

| | | | | | | | | |

Введенный в R2018a

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

Поддержка

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