Объект встроенный объект
  1. титульная страница
  2. Встроенные объекты
  3. Объект HttpRequest

Объект HttpRequest

http Запросить объект сообщения

Наследование

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>Message|new Message()|TEXT;BINARY|value;params;type;data;body;length;stream;lastError|read();readAll();write();json();pack();end();isEnded();clear();sendTo();readFrom()] [<class>HttpMessage|protocol;headers;keepAlive;upgrade;maxHeadersCount;maxBodySize;socket|hasHeader();firstHeader();allHeader();addHeader();setHeader();removeHeader()] [<this>HttpRequest|new HttpRequest()|response;method;address;queryString;cookies;form;query] [object] <:- [Message] [Message] <:- [HttpMessage] [HttpMessage] <:- [HttpRequest] Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() HttpMessage protocol headers keepAlive upgrade maxHeadersCount maxBodySize socket hasHeader() firstHeader() allHeader() addHeader() setHeader() removeHeader() HttpRequest new HttpRequest() response method address queryString cookies form query object toString() toJSON()

Конструктор

HttpRequest

Конструктор HttpRequest для создания нового объекта HttpRequest

1
new HttpRequest();

постоянный

TEXT

Укажите тип сообщения 1, который представляет тип текста

1
const HttpRequest.TEXT = 1;

BINARY

Укажите тип сообщения 2, который представляет двоичный тип

1
const HttpRequest.BINARY = 2;

Атрибуты члена

response

HttpResponse, Получить объект сообщения ответа

1
readonly HttpResponse HttpRequest.response;

method

Строка, запрос и метод установки запроса

1
String HttpRequest.method;

address

Строка, запрос и установка адреса запроса

1
String HttpRequest.address;

queryString

Строка, запрос и строка запроса установки запроса

1
String HttpRequest.queryString;

cookies

HttpCollection, Получить контейнер, содержащий файлы cookie сообщений

1
readonly HttpCollection HttpRequest.cookies;

form

HttpCollection, Получите контейнер, содержащий форму сообщения

1
readonly HttpCollection HttpRequest.form;

query

HttpCollection, Получите контейнер, содержащий запрос сообщения

1
readonly HttpCollection HttpRequest.query;

protocol

Строка, информация о версии протокола, допустимый формат: HTTP /#.#

1
String HttpRequest.protocol;

headers

HttpCollection, Включено в сообщение http Контейнер заголовка сообщения, атрибут только для чтения

1
readonly HttpCollection HttpRequest.headers;

keepAlive

Логическое, запрос и установка, сохранять ли соединение

1
Boolean HttpRequest.keepAlive;

upgrade

Логическое значение, запрос и установка, является ли это соглашением об обновлении

1
Boolean HttpRequest.upgrade;

maxHeadersCount

Целое число, запрос и установка максимального количества заголовков запроса, по умолчанию 128

1
Integer HttpRequest.maxHeadersCount;

maxBodySize

Целое число, запрос и установка максимального размера тела в МБ, по умолчанию 64

1
Integer HttpRequest.maxBodySize;

socket

Stream, Запросить исходный сокет текущего объекта

1
readonly Stream HttpRequest.socket;

value

Строка, основное содержание сообщения

1
String HttpRequest.value;

params

NArray, основные параметры сообщения

1
readonly NArray HttpRequest.params;

type

Целое число, тип сообщения

1
Integer HttpRequest.type;

data

Значение, запрашивать данные сообщения, этот атрибут будет возвращать разные данные в соответствии с типом содержимого, когда это текст, он возвращает текст, который json При возвращении json, В других случаях вернуться к двоичному

1
readonly Value HttpRequest.data;

body

SeekableStream, Объект потока, который содержит часть сообщения с данными.

1
SeekableStream HttpRequest.body;

length

Long, длина информационной части сообщения.

1
readonly Long HttpRequest.length;

stream

Stream, Запрашивать объект потока при чтении сообщения

1
readonly Stream HttpRequest.stream;

lastError

Строка, запрос и установка последней ошибки обработки сообщения

1
String HttpRequest.lastError;

Функция члена

hasHeader

Проверить, есть ли заголовок сообщения с указанным значением ключа

1
Boolean HttpRequest.hasHeader(String name);

Параметры звонка:

  • name: String, укажите значение ключа для проверки

Результат возврата:

  • Boolean, Возвращает, существует ли значение ключа

firstHeader

Запросить заголовок первого сообщения с указанным значением ключа

1
String HttpRequest.firstHeader(String name);

Параметры звонка:

  • name: String, укажите значение ключа для запроса

Результат возврата:

  • String, Возвращает значение, соответствующее значению ключа, если оно не существует, возвращает undefined

allHeader

Запросить все заголовки сообщений с указанным значением ключа

1
NObject HttpRequest.allHeader(String name = "");

Параметры звонка:

  • name: String, укажите значение ключа для запроса, передайте пустую строку, чтобы вернуть результат всех значений ключа

Результат возврата:

  • NObject, Возвращает массив всех значений, соответствующих значению ключа, если данные не существуют, возвращает ноль

addHeader

Добавление заголовка сообщения, добавление данных не изменяет заголовок сообщения существующего значения ключа

1
HttpRequest.addHeader(Object map);

Параметры звонка:

  • map: Object, укажите словарь данных "ключ-значение", который нужно добавить

Добавление набора заголовков сообщений с указанным именем, добавление данных не изменяет заголовки сообщений существующего значения ключа

1
2
HttpRequest.addHeader(String name,
    Array values);

Параметры звонка:

  • name: String, укажите значение ключа, которое нужно добавить
  • values: Массив, укажите набор данных для добавления

Добавление заголовка сообщения, добавление данных не изменяет заголовок сообщения существующего значения ключа

1
2
HttpRequest.addHeader(String name,
    String value);

Параметры звонка:

  • name: String, укажите значение ключа, которое нужно добавить
  • value: String, укажите данные для добавления

setHeader

Установите заголовок сообщения, настройка данных изменит первое значение, соответствующее значению ключа, и очистит оставшиеся заголовки сообщений с тем же значением ключа.

1
HttpRequest.setHeader(Object map);

Параметры звонка:

  • map: Object, укажите словарь данных "ключ-значение", который нужно установить

Задайте набор заголовков сообщений с указанным именем, данные настройки изменят значение, соответствующее значению ключа, и очистят остальные заголовки сообщений с тем же значением ключа.

1
2
HttpRequest.setHeader(String name,
    Array values);

Параметры звонка:

  • name: String, укажите значение ключа, которое нужно установить
  • values: Массив, укажите набор данных для установки

Установите заголовок сообщения, настройка данных изменит первое значение, соответствующее значению ключа, и очистит оставшиеся заголовки сообщений с тем же значением ключа.

1
2
HttpRequest.setHeader(String name,
    String value);

Параметры звонка:

  • name: String, укажите значение ключа, которое нужно установить
  • value: String, укажите данные для установки

removeHeader

Удалить все заголовки сообщений указанного значения ключа

1
HttpRequest.removeHeader(String name);

Параметры звонка:

  • name: String, укажите значение ключа, которое нужно удалить

read

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

1
Buffer HttpRequest.read(Integer bytes = -1) async;

Параметры звонка:

  • bytes: Целое число, укажите объем данных для чтения, по умолчанию следует читать блок данных произвольного размера, размер считываемых данных зависит от устройства.

Результат возврата:

  • Buffer, Верните данные, прочитанные из потока, если нет данных для чтения или соединение прервано, то верните ноль

readAll

Прочитать все оставшиеся данные из потока, этот метод является псевдонимом соответствующего метода тела

1
Buffer HttpRequest.readAll() async;

Результат возврата:

  • Buffer, Верните данные, прочитанные из потока, если нет данных для чтения или соединение прервано, то верните ноль

write

Запишите заданные данные, этот метод является псевдонимом соответствующего метода тела

1
HttpRequest.write(Buffer data) async;

Параметры звонка:

  • data: Buffer, Учитывая данные для записи

json

Запишите данные в кодировке JSON

1
Value HttpRequest.json(Value data);

Параметры звонка:

  • data: Значение, учитывая данные для записи

Результат возврата:

  • Value, Этот метод не вернет данные

Анализируйте данные в сообщении в кодировке JSON

1
Value HttpRequest.json();

Результат возврата:

  • Value, Вернуть проанализированный результат

pack

к msgpack Кодировать для записи заданных данных

1
Value HttpRequest.pack(Value data);

Параметры звонка:

  • data: Значение, учитывая данные для записи

Результат возврата:

  • Value, Этот метод не вернет данные

к msgpack Кодирование и анализ данных в сообщении

1
Value HttpRequest.pack();

Результат возврата:

  • Value, Вернуть проанализированный результат

end

Установить конец обработки текущего сообщения,Chain Процессор не продолжает последующие транзакции

1
HttpRequest.end();

isEnded

Запросить, закончилось ли текущее сообщение

1
Boolean HttpRequest.isEnded();

Результат возврата:

  • Boolean, Верните истину в конце

clear

Очистить содержание сообщения

1
HttpRequest.clear();

sendTo

Отправить отформатированное сообщение заданному объекту потока

1
HttpRequest.sendTo(Stream stm) async;

Параметры звонка:

  • stm: Stream, Укажите объект потока для получения форматированных сообщений

readFrom

Прочтите отформатированное сообщение из данного объекта потока кэша и проанализируйте объект заполнения

1
HttpRequest.readFrom(Stream stm) async;

Параметры звонка:

  • stm: Stream, Укажите объект потока для чтения форматированных сообщений

toString

Возвращает строковое представление объекта, обычно возвращает «[Native Object]», объект может быть повторно реализован в соответствии с его собственными характеристиками.

1
String HttpRequest.toString();

Результат возврата:

  • String, Возвращает строковое представление объекта

toJSON

Возвращает представление объекта в формате JSON, обычно возвращает набор читаемых атрибутов, определенных объектом.

1
Value HttpRequest.toJSON(String key = "");

Параметры звонка:

  • key: Строка, не используется

Результат возврата:

  • Value, Возвращает значение, содержащее сериализуемый JSON
© Copyright 2012-2021 fibjs.org | Поддержите нас