matlab.net.http.io.StringProvider class

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

ContentProvider, чтобы отправить строки MATLAB

расширьте все на странице

Описание

Используйте StringProvider объект отправить строку MATLAB® или вектор символов в RequestMessage. По умолчанию, если RequestMessage.Body.Data свойство содержит строку или вектор символов, затем это преобразовано в двоичный файл согласно кодированию (набор символов), заданный или подразумеваемый полем Content-Type в сообщении, таким образом, вы не должны были бы обычно использовать этот объект отправить простой текст в случаях, где MATLAB может определить что кодирование использовать.

Используйте этот объект в Request.Body свойство отправить строку закодировало использование набора символов, который может отличаться от того, который MATLAB использовал бы в Типе контента в заголовке. Вы указываете что набор символов в ContentProvider конструктор или путем установки Charset свойство. Если сообщение не содержит Типа контента, этот провайдер добавляет одно определение "text/plain" и заданный набор символов.

matlab.net.http.io.StringProvider классом является handle класс.

Создание

Описание

пример

provider = StringProvider создает StringProvider отправить данные в Data свойство, закодированное со значением, заданным в Charset свойство. Установите эти свойства прежде, чем отправить сообщение, которое содержит этого провайдера.

provider = StringProvider(data,charset) создает StringProvider отправить заданный data закодированный с заданным charset. Конструктор устанавливает Data свойство к значению data и Charset свойство к значению charset. charset аргумент является дополнительным.

Свойства

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

Общественные собственности

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

Авторы подкласса могут установить это свойство на новые данные в любое время. Следующий вызов getData преобразует эти данные, до значения getData length аргумент.

Атрибуты:

GetAccess
public
SetAccess
public
Dependent
true

Набор символов используется в кодировании, заданный как вектор символов.

Атрибуты:

GetAccess
public
SetAccess
public
Dependent
true

Поля заголовка сообщения или части, заданной как вектор одного или нескольких matlab.net.http.HeaderField объекты.

Это свойство только используется авторами подкласса. MATLAB устанавливает это свойство прежде, чем вызвать complete провайдера метод. Для немногослойных сообщений MATLAB инициализирует это свойство к содержимому Request.Header, минус любой matlab.net.http.field.GenericFields или поля с пустым знаком. ContentProvider использование это свойство добавить поля заголовка, которые описывают данные, которые будут отправлены или добавят параметры в поля заголовка уже в сообщении. В делегате к MultipartProvider, MATLAB инициализирует это свойство к полям заголовка, которые провайдер делегирования намеревается вставить для части. Делегаты могут изменить или изменить эти поля.

По возврату из complete провайдера метод, если это не многослойное сообщение, то MATLAB читает это свойство и объединяет его содержимое в заголовок Request. Поля в этом Header с Names это уже не появляется в Request.Header добавляются в конец Request.Header. Если поле в этом Header имеет Name это эквивалентно один в Request.Header, и у обоих есть непустой Valuesзатем:

  • Если тот в Request.Header GenericField, затем проигнорируйте тот в Header.

  • Если тот в Request.Header не GenericField, затем замените его на тот в Header.

Если один или оба из них имеет пустой Value, затем поле удалено из Request.Header и это не добавляется как часть нормального завершения сообщения.

Если это - делегат MultipartProvider, затем целое содержимое этого Header используется в качестве заголовка части. Многослойные делегаты не должны принимать тот Request.Header содержит любые поля, имеющие отношение к их собственному Header. Провайдер может определить, является ли это многослойным делегатом путем проверки ли MyDelegator MultipartProvider, хотя этот тест вряд ли будет необходим.

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

Авторы класса должны иметь в виду, что их подклассы могут добавить поля в этот Header (в их complete метод) прежде, чем вызвать complete в их суперклассе. Лучше сохранять такие поля а не добавлять поля с теми же именами. Однако добавление параметра к полю допустимо. Например, суперкласс может добавить параметр набора символов в существующее поле Content-Type, которое уже не имеет того.

Атрибуты:

GetAccess
public
SetAccess
public

Укажите, обеспечить ли разделенное на блоки кодирование передачи, заданное как булевская переменная. Это свойство представляет интерес только, чтобы разделить авторов на подклассы и применимо только к провайдерам, которые не являются многослойными делегатами. Подклассы устанавливают ForceChunked управлять, должно ли содержимое быть отправлено с помощью разделенного на блоки кодирования передачи. Если false (значение по умолчанию), MATLAB решает, отправить ли разделенное на блоки содержимое, на основе того, знает ли это длину содержимого в то время, когда сообщение готово быть отправленным:

  • Если MATLAB знает длину содержимого (который имеет место, если сообщение содержит поле Content-Length, или если expectedContentLength этого провайдера метод возвратил номер), затем MATLAB решает, отправить ли разделенный на блоки или нет.

  • Если MATLAB не знает длины содержимого (никакое поле Content-Length в заголовке и expectedContentLength возвращенный пустой), затем MATLAB всегда отправляет разделенное на блоки сообщение.

Если ForceChunked true, затем MATLAB отправляет сообщение, разделенное на блоки независимо от того, знает ли это длину содержимого, если известная длина не меньше, чем размер фрагмента. Если этим свойством является true, затем сообщение не должно содержать поле Content-Length, потому что HTTP не позволяет разделенному на блоки сообщению иметь поле Content-Length. Однако можно все еще возвратить ненулевое значение в expectedContentLength метод, если вы хотите, чтобы MATLAB проверил, что вы возвращаете ожидаемую длину данных.

Когда MATLAB принимает решение отправить разделенное на блоки сообщение, размер каждого фрагмента равен длине данных, возвращенных getData.

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

Атрибуты:

GetAccess
public
SetAccess
public

Запросите сообщение отправить, заданный как matlab.net.http.RequestMessage объект.

Это свойство используется только авторами подкласса. RequestMessage.send и RequestMessage.complete методы устанавливают это свойство на RequestMessage в чьем Body этот провайдер был помещен, прежде, чем вызвать любые другие методы в этом провайдере, и прежде, чем добавить любые дополнительные поля заголовка или подтвердить сообщение. Провайдер может исследовать это сообщение, чтобы видеть то, что содержалось в исходном запросе.

Делегаты видят то же значение для этого свойства как delegator. ContentProviders должно иметь в виду, что, если они - делегаты, они не обязательно обеспечивают целое тело сообщения запроса, таким образом, они не должны принимать, что поля заголовка в этом Запросе являются подходящими для данных, которые они обеспечивают. Обычно, делегаты должны проигнорировать поля заголовка в этом запросе, относящемся к данным, такие как Тип контента.

Если провайдер хочет добавить какие-либо поля заголовка в это сообщение или изменить существующие единицы, это должно сделать так в его complete метод путем добавления тех полей в Header свойство. Вызывающая сторона complete (RequestMessage или провайдер делегирования), определяет, что сделать с теми полями. RequestMessage.send и RequestMessage.complete всегда копируйте эти поля в Header из RequestMessage. Провайдер делегирования может скопировать поля в свой собственный Header свойство или вставляет их в сообщение (как в случае MultipartProvider). Для получения дополнительной информации смотрите свойство Header.

Это свойство доступно только для чтения.

Атрибуты:

GetAccesspublic
SetAccessmatlab.net.http.RequestMessage

Защищенные свойства

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

complete методы устанавливают это свойство опустеть.

Атрибуты:

GetAccess
protected
SetAccess
protected

ContentProvider это делегировало к этому провайдеру, заданному как matlab.net.http.io.ContentProvider объект.

Если ContentProvider ответственность делегатов за отправку всех или фрагмента данных о сообщении к другому провайдеру, затем это свойство идентифицирует провайдера делегирования делегату. Например, MultipartProvider части делегатов сообщения к другим провайдерам, таким образом, это вставляет указатель на себя в каждом делегате. В противном случае, MyDelegator isempty. delegateTo метод устанавливает это свойство в делегате.

Атрибуты:

GetAccess
protected
SetAccess
protected

Методы

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

Примеры

свернуть все

Следующий код готовит сообщение, которое отправляет строке "myText" использование Типа контента "text/plain" к серверу с помощью кодирования Shift_JIS:

ctf = ContentTypeField(MediaType('text/plain','charset','Shift_JIS');
r = RequestMessage('put',ctf,StringProvider('myText'));

В этом примере заголовок не имеет никакого поля Content-Type, таким образом, StringProvider вставляет один на основе аргументов конструктора.

r = RequestMessage('put',[],StringProvider('myText','Shift_JIS'));
show(r.complete('www.someurl.com'))
PUT / HTTP/1.1
      Host: www.someurl.com
      Content-Type: text/plain; charset=Shift_JIS
      User-Agent: MATLAB/9.2.0.512567 (R2017b)
      Connection: close
      Date: Fri, 20 Jun 2017 14:26:42 GMT

В этом примере, набор символов, заданный к StringProvider конструктор, используемый, чтобы преобразовать данные, отличается от набора символов в поле Content-Type. StringProvider не изменяет существующее поле Content-Type, которое уже задает набор символов, таким образом, сервер принимает, что данными является US-ASCII, не Shift JIS.

ctf = ContentTypeField(MediaType('text/plain','charset','US-ASCII'));
      r = RequestMessage('put',ctf,StringProvider('myText','Shift_JIS'));

В этом примере MATLAB добавляет параметр набора символов в поле Content-Type, которое не задавало набор символов, потому что значение по умолчанию для "application/json" UTF-8, который отличается от Shift_JIS.

ctf = ContentTypeField(MediaType('application/json'));
      r = RequestMessage('put',ctf,StringProvider('myText','Shift_JIS'));
      show(r.complete('www.someurl.com'))
PUT / HTTP/1.1
      Host: www.someurl.com
      Content-Type: application/json; charset=Shift_JIS
      User-Agent: MATLAB/9.2.0.512567 (R2017b)
      Connection: close
      Date: Fri, 20 Jun 2017 14:26:42 GMT

Когда нет никакого поля заголовка Типа контента, и никакой набор символов не задан к StringProvider, MATLAB использует эвристику, чтобы найти "минимальное" кодирование, которое может представлять данные, одни из которых включают кодировку по умолчанию для платформы. В этом примере, когда работавший Windows, символы Unicode® в строке в области значений Windows 1252, но вне области значений US-ASCII, таким образом, Windows 1252 используется:

r = RequestMessage('put',[],StringProvider('€abc'));
      show(r.complete('www.someurl.com'))
PUT / HTTP/1.1
      Host: www.someurl.com
      Content-Type: text/plain; charset=windows-1252
      User-Agent: MATLAB/9.2.0.512567 (R2017b)
      Connection: close
      Date: Fri, 20 Jun 2017 14:26:42 GMT

В этом случае поле Content-Type задает "application/json" без набора символов, и ни один не задан к StringProvider. Начиная с набора символов по умолчанию для "application/json" UTF-8, StringProvider использование, что преобразовать и не задает набор символов явным образом в поле Content-Type.

ctf = ContentTypeField(MediaType('application/json'));
      r = RequestMessage('put',ctf,StringProvider('myText')); % uses UTF-8

Больше о

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

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

|

Введенный в R2018a

Документация MATLAB
Поддержка
Для просмотра документации необходимо авторизоваться на сайте