Класс QNetworkRequest

Класс QNetworkRequest содержит запрос, который будет отправлен с помощью QNetworkAccessManager. Подробнее...

• Список всех членов, включая унаследованные члены

Открытые типы

Открытые функции

Подробное описание

QNetworkRequest является частью API доступа к сети и представляет собой класс, содержащий информацию, необходимую для отправки запроса по сети. Он содержит URL-адрес и некоторую дополнительную информацию, которая может быть использована для изменения запроса.

См. также QNetworkReply и QNetworkAccessManager.

Документация по типам членов

enum QNetworkRequest::Attribute

Коды атрибутов для QNetworkRequest и QNetworkReply.

Атрибуты — это дополнительные метаданные, используемые для управления поведением запроса и передачи дополнительной информации из ответа обратно в приложение. Атрибуты также расширяемы, что позволяет пользовательским реализациям передавать пользовательские значения.

В следующей таблице объясняется, каковы коды атрибутов по умолчанию, типы QVariant, связанные с ними, значение по умолчанию, если данный атрибут отсутствует, и используется ли он в запросах или ответах.

enum QNetworkRequest::CacheLoadControl

Управляет механизмом кэширования QNetworkAccessManager.

enum QNetworkRequest::KnownHeaders

Список известных типов заголовков, которые анализирует QNetworkRequest. Каждый известный заголовок также представлен в сыром виде со своим полным именем HTTP.

См. также header(), setHeader(), rawHeader(), и setRawHeader().

enum QNetworkRequest::LoadControl

Указывает, была ли вручную переопределена какая-либо сторона механизма загрузки запроса, например, Qt WebKit.

enum QNetworkRequest::Priority

В этом перечислении перечислены возможные приоритеты сетевых запросов.

enum QNetworkRequest::RedirectPolicy

Указывает, следует ли API доступа к сети автоматически перенаправлять ответ HTTP или нет.

Это перечисление было введено или изменено в Qt 5.9.

enum QNetworkRequest::TransferTimeoutConstant

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

Это перечисление было введено или изменено в Qt 5.15.

Документация по членам функций

QNetworkRequest::QNetworkRequest(const QNetworkRequest &other)

Создаёт копию other.

QNetworkRequest::QNetworkRequest(const QUrl &url)

Конструирует объект QNetworkRequest с url в качестве URL, который необходимо запросить.

См. также url() и setUrl().

QNetworkRequest::QNetworkRequest()

Конструирует объект QNetworkRequest без URL, который необходимо запросить. Используйте setUrl() для его установки.

См. также url() и setUrl().

QNetworkRequest &QNetworkRequest::operator=(const QNetworkRequest &other)

Создаёт копию other.

QNetworkRequest::~QNetworkRequest()

Удаляет объект QNetworkRequest.

QVariant QNetworkRequest::attribute(QNetworkRequest::Attribute code, const QVariant &defaultValue = QVariant()) const

Возвращает атрибут, связанный с кодом code. Если атрибут не задан, возвращает defaultValue.

Примечание: Эта функция не применяет значения по умолчанию, указанные в QNetworkRequest::Attribute.

См. также setAttribute() и QNetworkRequest::Attribute.

bool QNetworkRequest::hasRawHeader(const QByteArray &headerName) const

Возвращает true, если в этом сетевом запросе присутствует сырой заголовок headerName.

См. также rawHeader() и setRawHeader().

QVariant QNetworkRequest::header(QNetworkRequest::KnownHeaders header) const

Возвращает значение известного сетевого заголовка header, если он присутствует в этом запросе. Если он отсутствует, возвращает QVariant() (т.е. недействительный вариант).

См. также KnownHeaders, rawHeader() и setHeader().

[since 5.14] QHttp2Configuration QNetworkRequest::http2Configuration() const

Возвращает текущие параметры, используемые QNetworkAccessManager для этого запроса и его базового подключения HTTP/2. Это либо конфигурация, ранее заданная приложением, либо конфигурация по умолчанию.

Значения по умолчанию, используемые QNetworkAccessManager:

• Размер окна для управления потоком на уровне подключения составляет 2147483647 байт
• Размер окна для управления потоком на уровне потока составляет 21474836 байт
• Максимальный размер кадра составляет 16384

По умолчанию отправка сервера отключена, сжатие Хаффмана и индексация строк включены.

Функция была добавлена в Qt 5.14.

См. также setHttp2Configuration.

[since 5.6] int QNetworkRequest::maximumRedirectsAllowed() const

Возвращает максимальное количество разрешенных перенаправлений для этого запроса.

Функция была добавлена в Qt 5.6.

См. также setMaximumRedirectsAllowed().

QObject *QNetworkRequest::originatingObject() const

Возвращает ссылку на объект, который инициировал этот сетевой запрос; возвращает nullptr, если не задано или объект был уничтожен.

См. также setOriginatingObject().

[since 5.13] QString QNetworkRequest::peerVerifyName() const

Возвращает имя хоста, установленное для проверки сертификата, заданное с помощью setPeerVerifyName. По умолчанию возвращает пустую строку.

Функция была добавлена в Qt 5.13.

См. также setPeerVerifyName.

QNetworkRequest::Priority QNetworkRequest::priority() const

Возвращает приоритет этого запроса.

См. также setPriority().

QByteArray QNetworkRequest::rawHeader(const QByteArray &headerName) const

Возвращает сырое представление заголовка headerName. Если такого заголовка нет, возвращается пустой QByteArray, что может быть неочевидным, так как заголовок может быть, но не содержать значения (используйте hasRawHeader(), чтобы узнать, существует ли заголовок).

Сырые заголовки можно установить с помощью setRawHeader() или setHeader().

См. также header() и setRawHeader().

QList<QByteArray> QNetworkRequest::rawHeaderList() const

Возвращает список всех сырых заголовков, установленных в этом сетевом запросе. Список отсортирован в порядке установки заголовков.

См. также hasRawHeader() и rawHeader().

void QNetworkRequest::setAttribute(QNetworkRequest::Attribute code, const QVariant &value)

Устанавливает атрибут, связанный с кодом code, со значением value. Если атрибут уже установлен, предыдущее значение отбрасывается. В частности, если value — недействительный QVariant, атрибут сбрасывается.

См. также attribute() и QNetworkRequest::Attribute.

void QNetworkRequest::setHeader(QNetworkRequest::KnownHeaders header, const QVariant &value)

Устанавливает значение известного заголовка header равным value, перезаписывая любые ранее установленные заголовки. Эта операция также устанавливает эквивалентный сырой HTTP-заголовок.

См. также KnownHeaders, setRawHeader() и header().

[since 5.14] void QNetworkRequest::setHttp2Configuration(const QHttp2Configuration &configuration)

Устанавливает параметры HTTP/2 запроса из configuration.

Примечание: Конфигурация должна быть установлена до отправки запроса.

Примечание: HTTP/2 мультиплексирует несколько потоков в одном подключении HTTP/2. Это означает, что QNetworkAccessManager будет использовать конфигурацию, найденную в первом запросе из серии запросов, отправленных на тот же хост.

Функция была добавлена в Qt 5.14.

См. также http2Configuration, QNetworkAccessManager и QHttp2Configuration.

[since 5.6] void QNetworkRequest::setMaximumRedirectsAllowed(int maxRedirectsAllowed)

Устанавливает максимальное количество разрешенных перенаправлений для этого запроса в maxRedirectsAllowed.

Функция была добавлена в Qt 5.6.

См. также maximumRedirectsAllowed().

void QNetworkRequest::setOriginatingObject(QObject *object)

Разрешает установку ссылки на объект object, инициирующий запрос.

Например, Qt WebKit устанавливает исходный объект в QWebFrame, который инициировал запрос.

См. также originatingObject().

[since 5.13] void QNetworkRequest::setPeerVerifyName(const QString &peerName)

Устанавливает peerName в качестве имени хоста для проверки сертификата вместо имени, используемого для TCP-соединения.

Функция была добавлена в Qt 5.13.

См. также peerVerifyName.

void QNetworkRequest::setPriority(QNetworkRequest::Priority priority)

Устанавливает приоритет этого запроса в priority.

Примечание: priority — это только подсказка для менеджера сетевого доступа. Он может ее использовать или нет. В настоящее время он используется для HTTP, чтобы определить, какой запрос должен быть отправлен серверу в первую очередь.

См. также priority().

void QNetworkRequest::setRawHeader(const QByteArray &headerName, const QByteArray &headerValue)

Устанавливает заголовок headerName со значением headerValue. Если headerName соответствует известному заголовку (см. QNetworkRequest::KnownHeaders), сырой формат будет проанализирован, и соответствующий "обработанный" заголовок также будет установлен.

Например:

request.setRawHeader(QByteArray("Last-Modified"), QByteArray("Sun, 06 Nov 1994 08:49:37 GMT"));

также установит известный заголовок LastModifiedHeader на объект QDateTime с проаналированной датой.

Примечание: Установка одного и того же заголовка дважды перезаписывает предыдущее значение. Чтобы получить поведение нескольких HTTP-заголовков с одинаковым именем, следует конкатенировать два значения, разделяя их запятой (",") и установить один единственный сырой заголовок.

См. также KnownHeaders, setHeader(), hasRawHeader() и rawHeader().

void QNetworkRequest::setSslConfiguration(const QSslConfiguration &config)

Устанавливает конфигурацию SSL для этого сетевого запроса на config. Настройки, которые применяются, это закрытый ключ, локальный сертификат, протокол SSL (SSLv2, SSLv3, TLSv1.0, если применимо), сертификаты CA и шифры, которые разрешено использовать SSL-бекенду.

См. также sslConfiguration() и QSslConfiguration::defaultConfiguration().

[since 5.15] void QNetworkRequest::setTransferTimeout(int timeout = DefaultTransferTimeoutConstant)

Устанавливает timeout как таймаут передачи в миллисекундах.

Передачи прерываются, если не передано ни одного байта до истечения таймаута. Ноль означает, что таймер не установлен. Если аргумент не указан, таймаут равен QNetworkRequest::DefaultTransferTimeoutConstant. Если эта функция не вызвана, таймаут отключён и имеет значение ноль.

Данная функция была добавлена в Qt 5.15.

См. также transferTimeout.

void QNetworkRequest::setUrl(const QUrl &url)

Устанавливает URL, на который ссылается этот сетевой запрос, на url.

См. также url().

QSslConfiguration QNetworkRequest::sslConfiguration() const

Возвращает конфигурацию SSL этого сетевого запроса. По умолчанию она такая же, как QSslConfiguration::defaultConfiguration().

См. также setSslConfiguration() и QSslConfiguration::defaultConfiguration().

[since 5.0] void QNetworkRequest::swap(QNetworkRequest &other)

Меняет местами этот сетевой запрос с other. Эта функция очень быстрая и никогда не терпит неудачу.

Данная функция была добавлена в Qt 5.0.

[since 5.15] int QNetworkRequest::transferTimeout() const

Возвращает таймаут, используемый для передач, в миллисекундах.

Этот таймаут равен нулю, если setTransferTimeout не вызывался, что означает, что таймаут не используется.

Данная функция была добавлена в Qt 5.15.

См. также setTransferTimeout.

QUrl QNetworkRequest::url() const

Возвращает URL, на который ссылается этот сетевой запрос.

См. также setUrl().

bool QNetworkRequest::operator!=(const QNetworkRequest &other) const

Возвращает false если этот объект не такой же, как other.

См. также operator==().

bool QNetworkRequest::operator==(const QNetworkRequest &other) const

Возвращает true если этот объект такой же, как other (т.е., если у них одинаковый URL, одинаковые заголовки и одинаковые настройки метаданных).

См. также operator!=().