Пакет: matlab.net.http.io
Суперклассы: matlab.net.http.io.ContentConsumer
Потребитель для файлов в сообщениях HTTP
FileConsumer
класс обеспечивает удобный способ загрузить файл с веб-сервиса или сохранить данные, полученные от сети в файле. Можно задать имя файла или позволить MATLAB® определить имя из информации, отправленной сервером или файлом с именем в URI.
matlab.net.http.io.FileConsumer
классом является handle
класс.
consumer = FileConsumer(
создает filename
,permission
,machineformat
,encoding
)FileConsumer
это создает или перезаписывает файл с полезной нагрузкой ответа с сервера. Параметры имеют то же значение как те fopen
функция, и все являются дополнительными.
consumer = FileConsumer(
устанавливает FID
)FileIdentifier
свойство к FID
и записи к тому файлу. FID
должен быть идентификатор файла, который вы открыли для записи. MATLAB пишет в файл в индикаторе текущего положения, поэтому если вы открываете существующий файл с помощью 'a+'
разрешение, например, MATLAB добавляет к файлу. Когда передача завершается, MATLAB оставляет индикатор положения в конце файла и не закрывает файл.
filename
— Имя файла или имя папкиИмя файла или имя папки, включая полный путь и дополнительное расширение в виде вектора символов или строкового скаляра. Чтобы определить имя файла, который создает MATLAB, смотрите Filename
свойство.
Если filename
задает файл в существующей папке, затем MATLAB:
Открывает файл с помощью fopen(filename,permission,...)
.
Если permission
не задан, затем открывает файл с помощью fopen(filename,'w+')
.
Если filename
не включает расширение, затем MATLAB добавляет один на основе поля заголовка Типа контента и/или Довольного Расположения в полученном сообщении или расширении имени файла в URI запроса, если таковые имеются.
Если filename
задает существующую, перезаписываемую папку, затем MATLAB создает файл в папке с именем, выведенным из поля заголовка Довольного Расположения в ответе или от URI, возможно добавляя расширение на основе Типа контента, если то имя не содержит тот.
Если filename
отсутствует или пустой, затем MATLAB создает файл в текущей папке. Это эквивалентно filename
= '.'
. Текущая папка является папкой в то время этот FileConsumer
был создан, не время, этот потребитель используется в send
запрос.
Пример: 'myTextFile.txt'
Типы данных: char |
string
permission
— Тип доступа к файлуw+
(значение по умолчанию) | u+
| u
| T
| значение позволено fopen
функцияТип доступа к файлу в виде строки. Если permission
задан, это должно позволить доступ для записи. Значением по умолчанию является 'w+'
, который открывает или создает файл для чтения и записи и отбрасывает существующее содержимое, если таковые имеются.
permission
может быть любое значение, позволенное fopen
функция. Следующие дополнительные значения permission
поддерживаются:
| То же самое как Например, если |
| Когда добавлено к разрешению, ведет себя так же к текстовому режиму |
Во всех случаях, для 'w'
и 'w+'
полномочия (или если permission
не задан), MATLAB не перезаписывает существующий файл, если имя файла не точно равно filename
.
Пример: 'a'
'w+T'
Типы данных: char |
string
machineformat
— Порядок для чтения или записи байтов или битовfopen
Порядок для чтения или записи байтов или битов в виде любого значения, позволенного fopen
функция.
Типы данных: char |
string
encoding
'CharacterEncoding' fopen
Кодировка символов в виде любого значения, позволенного fopen
функция.
Типы данных: char |
string
FileIdentifier
— Идентификатор файлаИдентификатор файла (FID), записанный в виде дважды. Если потребитель был создан с аргументом FID, то это свойство является идентификатором. Данные записаны в текущий индикатор позиции в файле, сопоставленный с этим идентификатором, таким образом, подклассы должны бояться менять положение случайно при использовании этого идентификатора. В конце передачи файл остается открытым, и положение остается в конце файла.
Если конструктор был вызван filename
аргумент, или без аргументов, затем это свойство является идентификатором файла только для чтения для того файла. Это позволяет подклассам читать файл во время передачи, не нарушая индикатор положения, используемый для записи. В конце передачи закрывается этот идентификатор.
GetAccess | public |
SetAccess | private |
Filename
— Имя пути к файлуstring.empty
(значение по умолчанию) | строкаИмя полного пути файла, записанного в виде строки. Если потребитель был создан с аргументом FID, то это свойство является именем файла. В противном случае это значение не может быть установлено, пока MATLAB не начал запись к файлу во время получения сообщения ответа, поскольку имя файла не может обязательно быть определено, пока все заголовки не были получены. Используйте это свойство определить файл, который был записан. Filename
также хранится в Response.Body.Data
свойство.
GetAccess | public |
SetAccess | private |
AllocationLength
— Предложенный buffer sizeuint64
Предложенный 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 | Запустите передачу файла к FileConsumer |
putData | Сохраните следующий буфер данных к файлу для FileConsumer |
delegateTo | Делегируйте другому потребителю |
ContentConsumer
| ContentTypeField
| FileProvider
| fopen
| RequestMessage
| ResponseMessage
1. Если смысл перевода понятен, то лучше оставьте как есть и не придирайтесь к словам, синонимам и тому подобному. О вкусах не спорим.
2. Не дополняйте перевод комментариями “от себя”. В исправлении не должно появляться дополнительных смыслов и комментариев, отсутствующих в оригинале. Такие правки не получится интегрировать в алгоритме автоматического перевода.
3. Сохраняйте структуру оригинального текста - например, не разбивайте одно предложение на два.
4. Не имеет смысла однотипное исправление перевода какого-то термина во всех предложениях. Исправляйте только в одном месте. Когда Вашу правку одобрят, это исправление будет алгоритмически распространено и на другие части документации.
5. По иным вопросам, например если надо исправить заблокированное для перевода слово, обратитесь к редакторам через форму технической поддержки.