Пакет: 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 добавляет его на основе поля заголовка Content-Type и/или Content-Disposition в полученном сообщении или расширения имени файла в URI запроса, если оно имеется.
Если filename указывает существующую папку с возможностью записи, затем MATLAB создает файл в папке с именем, полученным из поля заголовка Content-Disposition в ответе или из URI, возможно, добавляя расширение на основе Content-Type, если это имя не содержит его.
Если 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 - Кодировка символов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 - Предлагаемый размер буфераuint64Предлагаемый размер буфера, указанный как 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 метод вызывающего потребителя (делегатора) устанавливает CurrentDelegate собственность. Если текущее делегирование отсутствует, то значение равно [].
Наборы MATLAB CurrentDelegate кому [] перед вызовом initialize.
GetAccess | protected |
SetAccess | protected |
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 | protected |
SetAccess | protected |
MyDelegator — ContentConsumer делегированное этому потребителюmatlab.net.http.io.ContentConsumer | пустое ContentConsumer который делегирован этому потребителю, указанный как matlab.net.http.io.ContentConsumer объект. Если этот потребитель является делегатом, который был вызван другим потребителем, например GenericConsumer или MultipartConsumerТогда это вызывающий потребитель. Он пуст для потребителя верхнего уровня, указанного в вызове send.
Делегаты могут использовать это свойство для доступа к свойствам своих делегирователей, например, чтобы определить, какой потребитель делегировал им.
GetAccess | protected |
SetAccess | protected |
initialize | Подготовка потребителя к новой полезной нагрузке HTTP |
start | Начать передачу файла в FileConsumer |
putData | Сохранение следующего буфера данных в файл для FileConsumer |
delegateTo | Делегировать другому потребителю |
ContentConsumer | ContentTypeField | FileProvider | fopen | RequestMessage | ResponseMessage
1. Если смысл перевода понятен, то лучше оставьте как есть и не придирайтесь к словам, синонимам и тому подобному. О вкусах не спорим.
2. Не дополняйте перевод комментариями “от себя”. В исправлении не должно появляться дополнительных смыслов и комментариев, отсутствующих в оригинале. Такие правки не получится интегрировать в алгоритме автоматического перевода.
3. Сохраняйте структуру оригинального текста - например, не разбивайте одно предложение на два.
4. Не имеет смысла однотипное исправление перевода какого-то термина во всех предложениях. Исправляйте только в одном месте. Когда Вашу правку одобрят, это исправление будет алгоритмически распространено и на другие части документации.
5. По иным вопросам, например если надо исправить заблокированное для перевода слово, обратитесь к редакторам через форму технической поддержки.