Пакет: matlab.net.http. iO
Суперклассы: обработайте, matlab.mixin. Неоднородный
ContentProvider для HTTP передают полезные нагрузки
ContentProvider снабжает данными для RequestMessage HTTP, в то время как сообщение отправляется. Простой провайдер преобразовывает данные от типа MATLAB® до потока байтов. Более комплексные провайдеры могут "передать данные потоком" к серверу, получив, или генерируя данные в то же время он отправляется, таким образом избегая потребности иметь все данные в памяти перед запуском сообщения.
Обычно, при отправке данных в веб-сервис (обычно в PUT или запросе POST), вы создали бы RequestMessage и вставили бы данные в форме объекта MessageBody в свойстве RequestMessage.Body. Когда вы отправляете то сообщение с помощью RequestMessage.send, MATLAB преобразовывает это данные в поток байтов, который будет отправлен в сервер, преобразовывая его на основе Типа контента сообщения и типа данных в Body.Data Данные. Смотрите MessageBody.Data для этих правил преобразования.
Вместо того, чтобы вставить объект MessageBody в свойство RequestMessage.Body, можно создать объект ContentProvider и вставить это вместо этого. Затем когда вы отправляете сообщение, MATLAB вызывает методы в ContentProvider, чтобы получить буферы данных, чтобы отправить, в то время как сообщение отправляется.
Вставляете ли вы MessageBody или ContentProvider в сообщение, вызов RequestMessage.send не возвращается (то есть, это блокируется), пока целое сообщение не было отправлено, и ответ был получен, или ошибка произошла. Но с ContentProvider, MATLAB превращает периодические обратные вызовы в провайдера, чтобы получить буферы данных, чтобы отправить, в течение времени отправляют, блокируется. В этих обратных вызовах ваш ContentProvider может получить данные из любого источника, такие как файл, массив MATLAB, аппаратный датчик, функция MATLAB, и т.д. Задание провайдера должно преобразовать это данные в поток байтов, в форме буферов uint8, которые могут быть отправлены в сеть.
ContentProvider является абстрактным классом, разработанным для авторов класса, чтобы разделить на подклассы с их собственным генератором данных или конвертером, или можно использовать (или подкласс) одного из провайдеров MATLAB, которые генерируют данные для вас из различных источников, не пишущий подкласс. Эти провайдеры имеют опции, которые дают вам более гибкий контроль над тем, как данные получены и преобразованы, по сравнению с автоматическими преобразованиями, которые происходят, когда вы вставляете данные непосредственно в MessageBody. Используйте один из подклассов ContentProvider:
Даже если вы не должны передавать данные потоком, использование одного из этих провайдеров может упростить процесс отправки определенных типов содержимого, когда они преобразовывают данные от внутренней формы в поток uint8. Например, FormProvider позволяет вам отправить ответы формы на сервер, где можно удобно выразить данные как массив объектов QueryParameter. MultipartFormProvider позволяет вам отправить многослойные ответы формы, упрощая создание ответов на многослойные формы. Чтобы использовать любой ContentProvider, необходимо понять тип содержимого, которое сервер ожидает, что вы отправите.
Самый простой ContentProvider должен только реализовать метод getData, чтобы обеспечить буферы данных, когда MATLAB запрашивает их. Чтобы использовать вашего провайдера, вставьте его в в свойство Body RequestMessage. В этом примере третий аргумент конструктору RequestMessage, объекту MyProvider, входит в Body:
provider = MyProvider;
req = matlab.net.http.RequestMessage('put', headers, provider);
resp = req.send(uri);
Вот является пример классом 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
endMATLAB вызывает метод complete провайдера, когда он формирует новое сообщение, чтобы отправить. Цель состоит в том, чтобы позволить провайдеру готовиться к новому сообщению и добавлять любые необходимые поля заголовка к сообщению. MATLAB вызывает метод start провайдера, когда пора отправить данные, но перед первым вызовом getData.
Провайдер может быть прерываемым и/или допускающим повторное использование. Прерываемый означает, что провайдер может снова послать то же сообщение многократно с тем же потоком данных каждый раз, когда MATLAB вызывает start, даже если предыдущее использование не закончилось в нормальном завершении. Это поведение необходимо, потому что сервер может перенаправить сообщение к различному серверу, что означает потребности данных ретранслироваться. В этом случае MATLAB вызывает start, не вызывая complete снова. MATLAB вызывает метод restartable, чтобы определить, может ли провайдер быть перезапущен. Если ложь, MATLAB выдает исключение, если это должно вызвать start на провайдере, который был уже запущен, если не было никакого прошедшего вызова complete (который происходит только на новом сообщении).
Допускающий повторное использование означает, что провайдер может быть снова использован для различного (или то же самое) сообщение, каждый раз, когда MATLAB вызывает свой метод complete. MATLAB вызывает метод reusable, чтобы определить, может ли провайдер быть снова использован. Если false, то MATLAB выдает исключение, если это должно вызвать complete на провайдере, который был уже запущен. Если провайдер является допускающим повторное использование, то предположение - то, что следующий вызов start должен успешно выполниться, даже если провайдер является прерываемым.
ContentProvider возвращает false и для restartable и для reusable, поэтому если вы расширяете этот базовый класс непосредственно с прерываемым или допускающим повторное использование провайдером, необходимо заменить один или оба из этих методов, чтобы возвратить true. Все конкретные подклассы ContentProvider в пакете matlab.net.http.io являются и прерываемыми и допускающими повторное использование, таким образом, они возвращают true для этих методов. Если вы расширяете один из тех подклассов с провайдером, который не является допускающим повторное использование или прерываемым, замените один или оба из тех методов, чтобы возвратить false.
Класс MyProvider в этом примере не является прерываемым или допускающим повторное использование, потому что провайдер закрывает файл в конце сообщения. Чтобы сделать его допускающим повторное использование, вызов fopen должен произойти в методе complete вместо конструктора, таким образом восстановив состояние провайдера назад к тому, чем это было, прежде чем это использовалось для сообщения.
classdef MyProvider < matlab.net.http.io.ContentProvider
properties
FileID double
Name string
end
methods
function obj = MyProvider(name)
obj.Name = name;
end
function [data, stop] = getData(obj, length)
...as above...
end
function complete(obj, uri)
obj.FileID = fopen(name);
obj.complete@matlab.net.http.io.ContentProvider();
end
function tf = reusable(~)
tf = true;
end
function delete(obj)
...as above...
end
end
endЧтобы сделать провайдера прерываемым, добавьте restartable и методы start и выпустите fseek в методе start, чтобы "перемотать" файл:
function start(obj)
obj.start@matlab.net.http.io.ContentProvider();
fseek(obj.FileID, 0, -1);
end
function tf = restartable(~)
tf = true;
endКогда вы вызываете complete или send на RequestMessage, который содержит ContentProvider в его теле, MATLAB устанавливает свойство Request в провайдере к RequestMessage, в котором провайдер был помещен и свойство Header в заголовки в Request, прежде, чем добавить автоматические поля. Это затем вызывает следующие методы в провайдере в этом порядке:
завершенный- обращенный завершение сообщения, которое обычно происходит однажды на сообщение, когда вы вызываете RequestMessage.send или RequestMessage.complete завершенный. Провайдер, как ожидают, установит свое свойство Header на любые поля заголовка быть добавленным к сообщению, характерному для провайдера. Если MATLAB вызывает этот метод последующее время, провайдер должен принять, что это используется для нового сообщения. Большинство провайдеров должно реализовать этот метод, чтобы добавить их заголовки и затем, если они не прямой подкласс этого абстрактного класса, они должны вызвать свой суперкласс, завершенный, чтобы вызвать любое дополнительное поведение по умолчанию. MATLAB не вызывает complete несколько раз в провайдере, если его допускающий повторное использование метод не возвращает true. Этот абстрактный класс не является допускающим повторное использование по умолчанию, но все конкретные провайдеры в пакете matlab.net.http.io являются допускающими повторное использование.
preferredBufferSize/expectedContentLength - названный от RequestMessage.send, когда-то после complete, перед вызовом start. Большинство провайдеров не должно реализовывать эти методы, когда поведение по умолчанию является соответствующим. Однако провайдеры могут заменить это, чтобы поддержать аргумент force.
После возвращаются из этих методов, MATLAB отправляет заголовок RequestMessage к серверу. Когда пора отправить тело, MATLAB вызывает эти методы.
запуск- названный от RequestMessage.send, когда-то после вызова предыдущих методов, когда MATLAB решил, что сервер готов получить тело сообщения запроса. Если MATLAB вызывает это последующее время без прошедшего полного, провайдер должен принять, что просят снова послать тело того же сообщения (с теми же заголовками) еще раз. MATLAB не вызывает, запускаются несколько раз начиная с последней возможности к complete, если метод restartable провайдера не возвращает true. Этот абстрактный класс не является прерываемым по умолчанию, но все конкретные провайдеры в пакете matlab.net.http.io, являются прерываемыми.
getData - названный многократно после того, как вызов start, в то время как RequestMessage.send блокируется, каждый раз MATLAB, решает, что сервер готов к новому буферу данных. Метод должен возвратить вектор uint8 данных. Провайдер сигнализирует о конце данных путем возврата индикатора stop. Все провайдеры должны реализовать этот метод.
После того, как getData возвращает индикатор stop, MATLAB заканчивает сообщение запроса и ждет ответа с сервера.
ContentProvider, который вставляется в RequestMessage.Body, может делегировать к одному или нескольким другим провайдерам, чтобы обеспечить все или некоторые данные для сообщения. Например, MultipartProvider создает сообщение с несколькими частями, каждая из которых обеспечиваются различными другими провайдерами, заданными конструктору MultipartProvider. В этом случае MultipartProvider является delegator, и другие провайдеры являются делегатами, каждый названный в свою очередь, чтобы обеспечить его собственные поля заголовка и его фрагмент данных.
Провайдер делегирует другому путем вызова delegateTo, который устанавливает CurrentDelegate на делегата и MyDelegator делегата к текущему провайдеру (то есть, delegator), и затем вызывает complete делегата и методы start. Затем вызовы метода getData delegator CurrentDelegate.getData, чтобы получить данные, возможно изменяя его прежде, чем возвратить его в MATLAB. Провайдеры обычно не должны проверять, являются ли они делегатами, или кто делегировал им.
| завершенный | Полный HTTP-заголовок для ContentProvider |
| delegateTo | Делегируйте к другому провайдеру |
| expectedContentLength | Длина содержимого ContentProvider |
| getData | Следующий буфер данных, который отправит в HTTP, запрашивает сообщение от ContentProvider |
| preferredBufferSize | Предпочтительный buffer size для ContentProvider |
| прерываемый | Укажите, является ли ContentProvider прерываемым |
| допускающий повторное использование | Укажите, является ли ContentProvider допускающим повторное использование |
| show | Отобразите информацию о ContentProvider |
| запуск | Запустите передачу данных с ContentProvider |
| строка | Покажите ContentProvider как строку |
ContentConsumer | FileProvider | FormProvider | ImageProvider | JSONProvider | MultipartFormProvider | MultipartProvider | StringProvider | matlab.net. QueryParameter | matlab.net.http. MessageBody | matlab.net.http. RequestMessage