matlab.net.http.io.BinaryConsumer class
Пакет: matlab.net.http.io
Суперклассы: matlab.net.http.io.ContentConsumer
Потребитель для двоичных данных в сообщениях HTTP
Описание
Используйте BinaryConsumer копируемый объект необработанная полезная нагрузка к Response.Body.Data свойство. BinaryConsumer потребитель по умолчанию для GenericConsumer если никакой заданный потребитель не совпадает с типом.
BinaryConsumer класс предоставляется авторам подкласса, чтобы исследовать и обработать необработанные двоичные данные, в то время как он получается, возможно преобразовывая его в данные массива MATLAB®, чтобы храниться в Response.Body.Data.
matlab.net.http.io.BinaryConsumer классом является handle класс.
Создание
consumer = BinaryConsumer создает потребителя, чтобы получить двоичные данные от ResponseMessage.
Можно создать подкласс этого потребителя, чтобы исследовать необработанные данные, когда он получается, и затем делегируйте к этому классу, чтобы хранить данные в Данных.
Свойства
Общественные собственности
AllocationLength — Предложенный buffer size
uint64
Предложенный buffer size в виде uint64. MATLAB устанавливает AllocationLength к ожидаемому размеру буферов данных, переданных putData. Фактический размер может быть меньшим или больше. Чтобы улучшать производительность, потребитель может использовать это значение, чтобы предварительно выделить место, чтобы обработать данные.
MATLAB устанавливает это свойство прежде, чем вызвать start метод для удобства подклассов.
Атрибуты:
GetAccess | public |
SetAccess | public |
ContentLength — Ожидаемая длина полезной нагрузки
uint64 | пустой
Ожидаемая длина полезной нагрузки в виде uint64. Свойством обычно является Value свойство matlab.net.http.field.ContentLengthField в Header свойство.
Если ContentLength пусто, затем длина не известна. Полезная нагрузка заканчивается когда putData(uint8.empty) называется.
MATLAB устанавливает это свойство прежде, чем вызвать initialize, для удобства подклассов, которые могут извлечь выгоду из знания длины данных.
Если этот ContentConsumer делегат потребителя верхнего уровня, затем значение ContentLength может отличаться от ContentLength значение потребителя верхнего уровня.
Пример: numel(someData) где someData тип uint8
Атрибуты:
GetAccess | public |
SetAccess | public |
ContentType — Тип носителя полезной нагрузки
matlab.net.http.MediaType | пустой
Тип носителя полезной нагрузки в виде matlab.net.http.MediaType объект. Свойством обычно является Value свойство matlab.net.http.field.ContentTypeField в Header свойство. Если ContentType свойство пусто, затем ContentTypeField пусто или не существует.
MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов, которые могут хотеть исследовать MediaType. Подклассы могут установить это свойство, если они решают из данных, что это имеет различный MediaType.
В конце передачи MATLAB копирует это значение в Response.Body.ContentType свойство.
Пример: 'application/octet-stream'
Атрибуты:
GetAccess | public |
SetAccess | public |
Header — Заголовок полезной нагрузки, в настоящее время обрабатываемой
matlab.net.http.HeaderField
Заголовок полезной нагрузки, в настоящее время обрабатываемой в виде matlab.net.http.HeaderField объект.
Потребители используют этот заголовок, чтобы определить, как обработать полезную нагрузку, которая отправляется им. Для потребителя верхнего уровня это значение совпадает с Response.Header. Для делегата значение может отличаться. Например, в многослойном сообщении обрабатывается MultipartConsumer, это - заголовок части, которую обрабатывает этот делегат. Делегат может все еще исследовать Response.Header для заголовков исходного сообщения.
MATLAB устанавливает это свойство прежде, чем вызвать initialize, для удобства подклассов.
Атрибуты:
GetAccess | public |
SetAccess | public |
Request — Завершенный RequestMessage это было отправлено
matlab.net.http.RequestMessage
Завершенный RequestMessage это было отправлено в виде matlab.net.http.RequestMessage объект. Это - итоговый RequestMessage после всех перенаправлений, который является completedrequest возвращаемое значение от send метод.
MATLAB устанавливает это свойство прежде, чем вызвать initialize, для удобства подклассов.
Атрибуты:
GetAccess | public |
SetAccess | public |
Response — ResponseMessage быть обработанным
matlab.net.http.ResponseMessage
ResponseMessage будучи обработанным в виде matlab.net.http.ResponseMessage объект.
MATLAB устанавливает Response свойство прежде, чем вызвать initialize. Значением является ResponseMessage после того, как заголовки были получены, но прежде, чем получить любую полезную нагрузку. В начале обработки сообщения ответа (или запуск части для многослойных сообщений), ResponseMesssage.Body свойством является MessageBody объект с пустым Data и Payload свойства. Чтобы хранить полученные данные, потребители могут изменить Response и MessageBody.Data свойства во время передачи данных. Обычно, потребители, что процесс и затем хранит набор данных Response.Body.Data к их обработанной полезной нагрузке, хотя это не требуется. При завершении передачи MATLAB возвращает этот Response вызывающей стороне send. Потребители не должны изменять другой Response свойства, такие как Header или StatusLine, когда те изменения возвращены в вызывающую сторону send.
Response.Body.Payload свойство пусто во время передачи, и потребители не должны пытаться изменить его. Если HTTPOptions.SavePayload свойство установлено, затем MATLAB устанавливает Payload к полученной полезной нагрузке в конце передачи сообщения или части (после того, как вызов putData(uint8.empty)) или когда исключение происходит.
Если исключение происходит в потребителе во время обработки сообщения, то MATLAB выдает HTTPException объект. History свойство содержит этот Response значение.
Если потребитель является делегатом, который обрабатывает часть многослойного сообщения, то Response.Header содержит заголовок целого сообщения и Payload и Data свойства Response.Body очищены прежде, чем вызов ContentConsumer для каждой части. В конце каждой части, нового ResponseMessage добавляется в конец массива ResponseMessage объекты в Body.Data исходного ответа содержа Header от этого объекта и Body из этого свойства. Следующий делегат видит новый Response с пустым MessageBody, не MessageBody предыдущего делегата.
Атрибуты:
GetAccess | public |
SetAccess | public |
Dependent | true |
URI — Место назначения запроса обрабатывается
matlab.net.URI
Место назначения запроса, обрабатываемого в виде matlab.net.URI объект. Это значение является исходным целевым URI, как определено send. Это не URI прокси или итоговый URI после перенаправлений.
MATLAB устанавливает это свойство прежде, чем вызвать initialize, для удобства подклассов.
Атрибуты:
GetAccess | public |
SetAccess | public |
Защищенные свойства
AppendFcn — Функция вызвана putData добавлять дополнительные данные
указатель на функцию
Функция в виде указателя на функцию, вызванного putData метод, чтобы добавить дополнительные данные. putData метод в этом классе вызывает AppendFcn функция, чтобы добавить данные это получает в его data аргумент к существующим данным в сообщении ответа. Функция должна иметь подпись:
AppendFcn(consumer,newdata)
где newdata данные должны быть добавлены к массиву в consumer.Response.Body.Data. Это - ответственность этого метода обновить consumer.CurrentLength отразить новую длину Data. Если newdata пусто, который указывает на конец потока, затем функция должна обновить Response.Body.Data к его окончательному значению.
Поведение по умолчанию, если это свойство пусто, использует внутреннюю функцию, которая обрабатывает Data как массив произвольных значений, поддерживающих horzcat функция. Это эффективно добавляет newdata путем предварительно выделения места, поддержания CurrentLength быть фактической длиной хранимых данных. В конце сообщения это обрезает Response.Body.Data к CurrentLength.
Подклассы могут изменить это свойство если horzcat не подходит для добавлять процесса. Например, когда StringConsumer создает скалярную строку, она добавила бы к строке с помощью plus функция вместо horzcat.
Подклассы, которые не вызывают ContentConsumer.putData добавлять данные, или которые удовлетворены horzcat поведение при добавлении данных, может проигнорировать это свойство.
Пример: @customAppend где @customAppend задан потребителем
Атрибуты:
GetAccess | protected |
SetAccess | protected |
CurrentDelegate — ContentConsumer к которому этот потребитель делегирует
matlab.net.http.io.ContentConsumer | []
ContentConsumer к которому этот потребитель делегирует в виде matlab.net.http.io.ContentConsumer объект. delegateTo метод потребителя вызова (delegator) устанавливает CurrentDelegate свойство. Если нет никакой текущей делегации, то значением является [].
MATLAB устанавливает CurrentDelegate к [] прежде, чем вызвать initialize.
Атрибуты:
GetAccess | protected |
SetAccess | protected |
CurrentLength — Длина данных в настоящее время в Response.Body.Data
uint64.empty (значение по умолчанию) | uint64
Длина данных в настоящее время в Response.Body.Data свойство в виде uint64.
Это свойство используется когда Response.Body.Data был предварительно выделен размеру, больше, чем фактический объем данных, в настоящее время сохраненный, чтобы указать на длину тех хранимых данных. Если это свойство пусто, то это означает что весь Response.Body.Data содержит хранимые данные или что ContentConsumer подкласс избавляется от данных в некотором роде кроме хранения его в Response.Body.Data.
Это свойство используется и устанавливается putData метод в этом базовом классе, когда AppendFcn свойство пусто. Это - в пользу подклассов тот вызов putData и хочу исследовать уже сохраненные данные и/или любые реализации AppendFcn это обеспечивает результаты в Response.Body.Data.
Подклассы то использование putData также может изменить это свойство сбросить положение в буфере, где данные хранятся. Например, когда AppendFcn по умолчанию функция используется, подкласс что процессы весь Response.Body.Data на каждом вызове putData больше не может иметь использования для исходных данных, таким образом, они могут сбросить CurrentLength свойство к 1 так, чтобы следующий putData вызовите перезаписывает буфер с новыми данными. Нет никакой потребности очистить элементы в буфере мимо конца новых данных.
Подклассы, которые не вызывают putData может использовать это свойство отследить их собственные данные или может оставить его, сбросил (пустой). MATLAB не помещает ограничений на значение, которое может быть установлено здесь и не использует его ни в какой цели кроме определить где AppendFcn по умолчанию должен сохранить следующий буфер данных, и где обрезать данные в конце сообщения. Установите это свойство опустеть перед итоговым вызовом putData(uint8.empty) предотвратить усечение данных.
MATLAB устанавливает это свойство опустеть перед каждым вызовом initialize.
Атрибуты:
GetAccess | protected |
SetAccess | protected |
MyDelegator — ContentConsumer это делегировало этому потребителю
matlab.net.http.io.ContentConsumer | пустой
ContentConsumer это делегировало этому потребителю в виде matlab.net.http.io.ContentConsumer объект. Если этот потребитель является делегатом, который был вызван другим потребителем, таким как GenericConsumer или MultipartConsumer, затем это - потребитель вызова. Это пусто в потребителе верхнего уровня, заданном в вызове send.
Делегаты могут использовать это свойство получить доступ к свойствам их delegators, например, определить, который потребитель делегировал им.
Атрибуты:
GetAccess | protected |
SetAccess | protected |
Методы
Открытые методы
initialize | Подготовьте потребителя к новой полезной нагрузке HTTP |
start | Запустите передачу HTTP с BinaryConsumer |
putData | Сохраните следующий буфер данных для BinaryConsumer |
delegateTo | Делегируйте другому потребителю |
Примеры
Процесс uint8 Данные
Следующий потребитель комбинирует каждую пару uint8 байты получены в int16, и хранит int16 массив в ответе.
classdef MyBinaryConsumer < matlab.net.http.io.BinaryConsumer
properties
ExtraByte uint8
end
methods
function [len, stop] = putData(obj, data)
if isempty(data)
[len, stop] = obj.putData@matlab.net.http.io.BinaryConsumer(data);
else
if ~isempty(obj.ExtraByte)
data = [obj.ExtraByte; data];
end
len = length(data);
if mod(len,2) > 0
obj.ExtraByte = data(end);
len = len - 1;
else
obj.ExtraByte = uint8.empty;
end
res(1:len/2) = bitshift(uint16(data(1:2:len)),8)+uint16(data(2:2:len));
[len, stop] = obj.putData@matlab.net.http.io.BinaryConsumer(res);
end
end
end
methods(Access=protected)
function bs = start(obj)
obj.ExtraByte = uint8.empty;
bs = obj.start@matlab.net.http.io.BinaryConsumer();
end
end
end
Больше о
Иерархия классов
