Класс

matlab.net.http. iO . BinaryConsumer

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

Потребитель для двоичных данных в сообщениях HTTP

Описание

Используйте класс BinaryConsumer, чтобы скопировать необработанную полезную нагрузку в свойство Response.Body.Data. BinaryConsumer является потребителем по умолчанию для GenericConsumer, если никакой заданный потребитель не совпадает с типом.

Класс BinaryConsumer обеспечивается в пользу авторов подкласса, которые хотят исследовать и обработать необработанные двоичные данные, в то время как он получается, возможно преобразовывая его в данные массива MATLAB®, которые будут сохранены в Response.Body.Data Данные.

Конструкция

consumer = BinaryConsumer создает потребителя, чтобы получить двоичные данные от ResponseMessage.

Можно создать подкласс этого потребителя, чтобы исследовать необработанные данные, когда он получается, и затем делегируйте к этому классу, чтобы хранить данные в Response.Body.Data Данные.

Свойства

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

Предложенный buffer size, заданный как uint64. MATLAB устанавливает AllocationLength на ожидаемый размер буферов данных, переданных методу putData. Фактический размер может быть меньшим или больше. Чтобы улучшить производительность, потребитель может использовать это значение, чтобы предварительно выделить пробел, чтобы обработать данные.

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

Атрибуты:

GetAccesspublic
SetAccesspublic

Функция, заданная как указатель на функцию, вызванный методом 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 при добавлении данных, могут проигнорировать это свойство.

Атрибуты:

GetAccessprotected
SetAccessprotected

Ожидаемая длина полезной нагрузки, заданной как uint64. Свойство обычно является свойством Value matlab.net.http.field.ContentLengthField в свойстве Header.

Если ContentLength пуст, то длина не известна. Полезная нагрузка заканчивается, когда putData(uint8.empty) называется.

MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов, которые могут извлечь выгоду из знания длины данных.

Если этот consumer является делегатом потребителя верхнего уровня, то значение ContentLength может отличаться от значения ContentLength потребителя верхнего уровня.

Атрибуты:

GetAccesspublic
SetAccesspublic

MediaType полезной нагрузки, заданной как matlab.net.http.MediaType object. свойство обычно, является свойством Value matlab.net.http.field.ContentTypeField в свойстве Header. Если свойство ContentType пусто, то ContentTypeField пуст или не существует.

MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов, которые могут хотеть исследовать MediaType. Подклассы могут установить это свойство, если они решают от данных, что это имеет различный MediaType.

В конце передачи MATLAB копирует это значение в свойство Response.Body.ContentType.

Атрибуты:

GetAccesspublic
SetAccesspublic

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

Атрибуты:

GetAccessprotected
SetAccessprotected

Длина данных в настоящее время в свойстве 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.

Атрибуты:

GetAccessprotected
SetAccessprotected

Заголовок полезной нагрузки, в настоящее время обрабатываемой, заданный как matlab.net.http.HeaderField object.

Потребители используют этот заголовок, чтобы определить, как обработать полезную нагрузку, которая отправляется им. Для потребителя верхнего уровня это значение совпадает со свойством Response.Header. Для делегата значение может отличаться. Например, в многослойном сообщении, обработанном MultipartConsumer, это - заголовок части, которую обрабатывает этот делегат. Делегат может все еще исследовать Response.Header на заголовки исходного сообщения.

MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов.

Атрибуты:

GetAccesspublic
SetAccesspublic

ContentConsumer, который делегировал этому потребителю, заданному как объект matlab.net.http.io.ContentConsumer. Если этот потребитель является делегатом, который был вызван другим потребителем, таким как GenericConsumer или MultipartConsumer, то это - потребитель вызова. Это пусто в потребителе верхнего уровня, заданном в вызове matlab.net.http.RequestMessage.send .

Делегаты могут использовать это свойство получить доступ к свойствам их delegators, например, определить, который потребитель делегировал им.

Атрибуты:

GetAccessprotected
SetAccessprotected

Завершенный RequestMessage, который был отправлен, задал как matlab.net.http.RequestMessage object., Это - итоговый RequestMessage после всех перенаправлений, который является возвращаемым значением completedrequest из метода matlab.net.http.RequestMessage.send.

MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов.

Атрибуты:

GetAccesspublic
SetAccesspublic

ResponseMessage, обрабатываемый, заданный как matlab.net.http.ResponseMessage object.

MATLAB устанавливает свойство Response прежде, чем вызвать initialize. Значением является ResponseMessage после того, как заголовки были получены, но прежде, чем получить любую полезную нагрузку. В начале обработки сообщения ответа (или запуск части для многослойных сообщений), свойство ResponseMesssage.Body является объектом MessageBody с пустыми свойствами Data и Payload. Чтобы хранить полученные данные, потребители могут изменить свойства Response и MessageBody.Data во время передачи данных. Обычно, потребители, что процесс и затем хранит набор данных Response.Body.Data к их обработанной полезной нагрузке, хотя это не требуется. При завершении передачи MATLAB возвращает этот Response в вызывающую сторону matlab.net.http.RequestMessage.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 предыдущего делегата.

Атрибуты:

GetAccesspublic
SetAccesspublic

Место назначения запроса, обрабатываемого, заданного как matlab.net.URI object. Это значение, является исходным целевым URI, как определено matlab.net.http.RequestMessage.send ., Это не URI прокси или итоговый URI после перенаправлений.

MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов.

Атрибуты:

GetAccesspublic
SetAccesspublic

Методы

putDataСохраните следующий буфер данных для BinaryConsumer
запускЗапустите передачу HTTP с BinaryConsumer

Унаследованные методы

delegateToДелегируйте другому потребителю
инициализироватьПодготовьте потребителя к новой полезной нагрузке HTTP
putDataПроцесс или сохраняет следующий буфер данных для ContentConsumer
запускЗапустите передачу данных HTTP к ContentConsumer

Иерархия классов

Примеры

свернуть все

Следующий потребитель комбинирует каждую пару байтов 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

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

| |

Представленный в R2018a

Была ли эта тема полезной?