Пакет: matlab.net.http.io
Суперклассы: handle, matlab.mixin.Heterogeneous
Потребитель для HTTP передает полезные нагрузки
ContentConsumer является объектом, который преобразовывает или обрабатывает данные, полученные в объекте HTTP ResponseMessage. MATLAB® вызывает потребителя неоднократно во время получения сообщения ответа, чтобы обработать буферы полезной нагрузки, когда это получается. Можно действовать на или отобразить эти переданные потоком данные, в то время как они получаются. Также можно прервать передачу прежде, чем получить целое сообщение. Используя потребителя может улучшить latency (задержка между получением инструкции и начало передачи данных), когда время, чтобы обработать данные сопоставимо со скоростью сети. Это также позволяет вам получать неограниченные переданные потоком сообщения ответа.
ContentConsumer является абстрактным классом. Чтобы обработать входящие данные, полученные в сообщении ответа HTTP, используйте один из подклассов ContentConsumer:
Также можно записать, что вы владеете подклассом класса ContentConsumer или расширяете один из подклассов.
Класс matlab.net.http.io.ContentConsumer является классом handle.
ContentLength — Ожидаемая длина полезной нагрузкиuint64 | пустойОжидаемая длина полезной нагрузки, заданной как uint64. Свойство обычно является свойством Value matlab.net.http.field.ContentLengthField в свойстве Header.
Если ContentLength пуст, то длина не известна. Полезная нагрузка заканчивается, когда putData(uint8.empty) называется.
MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов, которые могут извлечь выгоду из знания длины данных.
Если этот ContentConsumer является делегатом потребителя верхнего уровня, то значение ContentLength может отличаться от значения ContentLength потребителя верхнего уровня.
Пример: numel(someData), где someData является типом uint8
| GetAccess | общественность |
| SetAccess | общественность |
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 | общественность |
| SetAccess | общественность |
AllocationLength — Предложенный buffer sizeuint64Предложенный buffer size, заданный как uint64. MATLAB устанавливает AllocationLength на ожидаемый размер буферов данных, переданных putData. Фактический размер может быть меньшим или больше. Чтобы улучшать производительность, потребитель может использовать это значение, чтобы предварительно выделить пробел, чтобы обработать данные.
MATLAB устанавливает это свойство прежде, чем вызвать метод start для удобства подклассов.
| GetAccess | общественность |
| SetAccess | общественность |
URI Место назначения запроса обрабатываетсяmatlab.net.URIМесто назначения запроса, обрабатываемого, заданного как объект matlab.net.URI. Это значение является исходным целевым URI, как определено send. Это не URI прокси или итоговый URI после перенаправлений.
MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов.
| GetAccess | общественность |
| SetAccess | общественность |
Request — Завершенный RequestMessage, который был отправленmatlab.net.http.RequestMessageЗавершенный RequestMessage, который был отправлен, задал как объект matlab.net.http.RequestMessage. Это - итоговый RequestMessage после всех перенаправлений, который является возвращаемым значением completedrequest из метода send.
MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов.
| GetAccess | общественность |
| SetAccess | общественность |
Response — ResponseMessage обрабатываетсяmatlab.net.http.ResponseMessageResponseMessage, обрабатываемый, заданный как объект 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 | общественность |
| SetAccess | общественность |
| Зависимый | tRUE |
Header — Заголовок полезной нагрузки, в настоящее время обрабатываемойmatlab.net.http.HeaderFieldЗаголовок полезной нагрузки, в настоящее время обрабатываемой, заданный как объект matlab.net.http.HeaderField.
Потребители используют этот заголовок, чтобы определить, как обработать полезную нагрузку, которая отправляется им. Для потребителя верхнего уровня это значение совпадает с Response.Header. Для делегата значение может отличаться. Например, в многослойном сообщении, обработанном MultipartConsumer, это - заголовок части, которую обрабатывает этот делегат. Делегат может все еще исследовать Response.Header на заголовки исходного сообщения.
MATLAB устанавливает это свойство прежде, чем вызвать initialize для удобства подклассов.
| GetAccess | общественность |
| SetAccess | общественность |
CurrentLength — Длина данных в настоящее время в Response.Body.Datauint64.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 | защищенный |
| SetAccess | защищенный |
CurrentDelegate — ContentConsumer, к которому этот потребитель делегируетmatlab.net.http.io.ContentConsumer | []ContentConsumer, к которому этот потребитель делегирует, заданный как объект matlab.net.http.io.ContentConsumer. Метод delegateTo потребителя вызова (delegator) устанавливает свойство CurrentDelegate. Если нет никакой текущей делегации, то значением является [].
MATLAB устанавливает CurrentDelegate на [] прежде, чем вызвать initialize.
| GetAccess | защищенный |
| SetAccess | защищенный |
MyDelegator — ContentConsumer, который делегировал этому потребителюmatlab.net.http.io.ContentConsumer | пустойContentConsumer, который делегировал этому потребителю, заданному как объект matlab.net.http.io.ContentConsumer. Если этот потребитель является делегатом, который был вызван другим потребителем, таким как GenericConsumer или MultipartConsumer, то это - потребитель вызова. Это пусто в потребителе верхнего уровня, заданном в вызове send.
Делегаты могут использовать это свойство получить доступ к свойствам их delegators, например, определить, который потребитель делегировал им.
| GetAccess | защищенный |
| SetAccess | защищенный |
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 | защищенный |
| SetAccess | защищенный |
initialize | Подготовьте потребителя к новой полезной нагрузке HTTP |
start | Запустите передачу данных HTTP к ContentConsumer |
putData | Процесс или сохраняет следующий буфер данных для ContentConsumer |
delegateTo | Делегируйте другому потребителю |
Когда вы задаете ContentConsumer в вызове RequestMessage.send, потребитель является потребителем top-level. MATLAB передает целую полезную нагрузку, когда это получается, буфер за один раз. Например:
req = RequestMesage; resp = req.send(url, [], MyConsumer);
Потребителем, вызванным другим потребителем, чтобы обработать все или часть данных в сообщении, является delegate.
В следующем коде mp является потребителем верхнего уровня, который получает целую полезную нагрузку многослойного сообщения.
mp = MultipartConsumer('image/*', ImageConsumer, 'text/*', StringConsumer); resp = req.send(url, [], mp);
ImageConsumer и объекты StringConsumer являются потребителями делегата, которые получают только те части полезной нагрузки, которые являются изображениями или текстом. GenericConsumer также использует делегатов. ContentConsumer обычно не заботится, является ли это потребителем верхнего уровня или делегатом. Любой потребитель в пакете matlab.net.http.io может работать делегатом.
BinaryConsumer | ContentLengthField | ContentProvider | ContentTypeField | FileConsumer | GenericConsumer | HeaderField | ImageConsumer | JSONConsumer | MediaType | MultipartConsumer | RequestMessage | ResponseMessage | StringConsumer | matlab.net.URI
1. Если смысл перевода понятен, то лучше оставьте как есть и не придирайтесь к словам, синонимам и тому подобному. О вкусах не спорим.
2. Не дополняйте перевод комментариями “от себя”. В исправлении не должно появляться дополнительных смыслов и комментариев, отсутствующих в оригинале. Такие правки не получится интегрировать в алгоритме автоматического перевода.
3. Сохраняйте структуру оригинального текста - например, не разбивайте одно предложение на два.
4. Не имеет смысла однотипное исправление перевода какого-то термина во всех предложениях. Исправляйте только в одном месте. Когда Вашу правку одобрят, это исправление будет алгоритмически распространено и на другие части документации.
5. По иным вопросам, например если надо исправить заблокированное для перевода слово, обратитесь к редакторам через форму технической поддержки.