Класс QNetworkReply

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

Этот класс был представлен в Qt 4.4.

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

Примечание: Все функции в этом классе являются реентерабельными.

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

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

Переопределённые открытые функции

Открытые слоты

Сигналы

Защищённые функции

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

Класс QNetworkReply содержит данные и метаданные, относящиеся к запросу, опубликованному с помощью QNetworkAccessManager. Как и QNetworkRequest, он содержит URL-адрес и заголовки (в парсинговом и сыром формате), некоторую информацию о состоянии ответа и содержимое самого ответа.

QNetworkReply — это устройство последовательного доступа QIODevice, что означает, что после считывания данных из объекта они больше не хранятся в устройстве. Поэтому ответственность за сохранение этих данных лежит на приложении, если оно их нуждается. Всякий раз, когда больше данных поступает из сети и обрабатывается, испускается сигнал readyRead().

Сигнал downloadProgress() также испускается при получении данных, но количество байтов в нём может не отражать фактическое количество полученных байтов, если над содержимым выполняется преобразование (например, распаковка и удаление избыточности протокола).

Несмотря на то, что QNetworkReply — это QIODevice, подключенный к содержимому ответа, он также испускает сигнал uploadProgress(), который указывает на прогресс загрузки для операций, имеющих такое содержимое.

Примечание: Не удаляйте объект в слоте, подключённом к сигналу errorOccurred() или finished(). Используйте deleteLater().

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

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

enum QNetworkReply::NetworkError

Указывает все возможные условия ошибок, обнаруженные во время обработки запроса.

Примечание: Когда протокол HTTP возвращает переадресацию, ошибка не будет сообщена. Вы можете проверить, есть ли переадресация, с помощью атрибута QNetworkRequest::RedirectionTargetAttribute.

См. также error() и errorOccurred().

typedef QNetworkReply::RawHeaderPair

RawHeaderPair — это QPair<QByteArray, QByteArray>, где первая QByteArray — имя заголовка, а вторая — заголовок.

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

[protected] QNetworkReply::QNetworkReply(QObject *parent = nullptr)

Создаёт объект QNetworkReply с родителем parent.

Вы не можете напрямую создавать объекты QNetworkReply. Используйте функции QNetworkAccessManager для этого.

[pure virtual slot] void QNetworkReply::abort()

Прерывает операцию немедленно и закрывает любые ещё открытые сетевые соединения. Загрузки, которые всё ещё выполняются, также прерываются.

Сигнал finished() также будет испущен.

См. также close() и finished().

[signal] void QNetworkReply::downloadProgress(qint64 bytesReceived, qint64 bytesTotal)

Этот сигнал испускается, чтобы указать прогресс загрузки части этого сетевого запроса, если таковой имеется. Если загрузка не ассоциирована с этим запросом, этот сигнал будет испущен один раз со значением 0 как для bytesReceived, так и для bytesTotal.

Параметр bytesReceived указывает количество полученных байтов, а bytesTotal — общее количество ожидаемых байтов для загрузки. Если количество байтов для загрузки неизвестно, bytesTotal будет равно -1.

Загрузка завершается, когда значение bytesReceived становится равным bytesTotal. В этот момент bytesTotal не будет равен -1.

Обратите внимание, что значения bytesReceived и bytesTotal могут отличаться от size(), общего количества байтов, полученных через read() или readAll(), или значения заголовка (ContentLengthHeader). Это связано с тем, что при загрузке может быть протокольный избыток или данные могут быть сжаты.

См. также uploadProgress() и bytesAvailable().

[signal] void QNetworkReply::encrypted()

Этот сигнал излучается, когда сессия SSL/TLS успешно завершила начальный обмен данными. В этот момент никакие пользовательские данные еще не переданы. Сигнал может быть использован для проведения дополнительных проверок цепочки сертификатов, например, для уведомления пользователей о том, что сертификат веб-сайта изменился. Если полученный ответ не соответствует ожидаемым критериям, необходимо прервать его, вызвав QNetworkReply::abort() из слота, подключенного к этому сигналу. Настройки SSL, используемые в данный момент, можно проверить с помощью метода QNetworkReply::sslConfiguration().

Внутренне, QNetworkAccessManager может открыть несколько подключений к серверу, чтобы обрабатывать запросы параллельно. Эти подключения могут быть повторно использованы, что означает, что сигнал encrypted() не будет излучаться. Это означает, что вы гарантированно получите этот сигнал только для первого подключения к сайту за время работы QNetworkAccessManager.

Эта функция была добавлена в Qt 5.1.

См. также QSslSocket::encrypted() и QNetworkAccessManager::encrypted().

[signal] void QNetworkReply::errorOccurred(QNetworkReply::NetworkError code)

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

Параметр code содержит код обнаруженной ошибки. Используйте errorString(), чтобы получить текстовое представление условия ошибки.

Примечание: Не удаляйте объект в слоте, подключенном к этому сигналу. Используйте deleteLater().

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

См. также error() и errorString().

[signal] void QNetworkReply::finished()

Этот сигнал излучается, когда обработка ответа завершена. После этого сигнала больше не будет обновлений данных или метаданных ответа.

Если не были вызваны close() или abort(), ответ останется открытым для чтения, поэтому данные можно получить, вызвав read() или readAll(). В частности, если в результате readyRead() не были сделаны вызовы read(), вызов readAll() извлечёт все содержимое в QByteArray.

Этот сигнал излучается вместе с QNetworkAccessManager::finished(), где параметр reply этого сигнала — этот объект.

Примечание: Не удаляйте объект в слоте, подключенном к этому сигналу. Используйте deleteLater().

Вы также можете использовать isFinished(), чтобы проверить, завершил ли QNetworkReply работу, даже прежде чем вы получите сигнал finished().

См. также setFinished(), QNetworkAccessManager::finished() и isFinished().

[virtual slot] void QNetworkReply::ignoreSslErrors()

Если эта функция вызвана, ошибки SSL, связанные с сетевым подключением, будут проигнорированы, включая ошибки проверки сертификатов.

Предупреждение: Убедитесь, что пользователь всегда может проверить ошибки, сообщенные сигналом sslErrors(), и вызовите этот метод только после подтверждения пользователем, что продолжение разрешено. Если возникнут непредвиденные ошибки, запрос следует прервать. Вызов этого метода без проверки фактических ошибок, скорее всего, создаст угрозу безопасности для вашего приложения. Используйте с большой осторожностью!

Эта функция может быть вызвана из слота, подключенного к сигналу sslErrors(), который указывает обнаруженные ошибки.

Примечание: Если для QNetworkAccessManager включена HTTP Strict Transport Security, эта функция не имеет эффекта.

См. также sslConfiguration(), sslErrors() и QSslSocket::ignoreSslErrors().

[signal] void QNetworkReply::metaDataChanged()

Этот сигнал излучается всякий раз, когда метаданные в этом ответе изменяются. Метаданные — это любая информация, которая не является самим содержимым (данными), включая сетевые заголовки. В большинстве случаев метаданные будут полностью известны к моменту получения первого байта данных. Однако возможно получение обновлений заголовков или других метаданных во время обработки данных.

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

[signal] void QNetworkReply::preSharedKeyAuthenticationRequired(QSslPreSharedKeyAuthenticator *authenticator)

Этот сигнал излучается, если обмен SSL/TLS согласовывает шифрование PSK, и поэтому требуется аутентификация PSK.

При использовании PSK клиент должен отправить серверу действительную идентификацию и действительный предварительно согласованный ключ, чтобы обмен SSL продолжился. Приложения могут предоставить эту информацию в слоте, подключенном к этому сигналу, заполнив переданный объект authenticator в соответствии со своими потребностями.

Примечание: Игнорирование этого сигнала или невозможность предоставить необходимые учетные данные приведут к сбою процесса обмена данными и, следовательно, к прерыванию подключения.

Примечание: Объект authenticator принадлежит ответу и не должен удаляться приложением.

Эта функция была добавлена в Qt 5.5.

См. также QSslPreSharedKeyAuthenticator.

[signal] void QNetworkReply::redirectAllowed()

Когда клиентский код, обрабатывающий сигнал redirected(), проверил новый URL, он излучает этот сигнал, чтобы разрешить переадресацию. Этот протокол применим к сетевым запросам, политика переадресации которых установлена в QNetworkRequest::UserVerifiedRedirectPolicy.

Эта функция была добавлена в Qt 5.9.

См. также QNetworkRequest::UserVerifiedRedirectPolicy, QNetworkAccessManager::setRedirectPolicy() и QNetworkRequest::RedirectPolicyAttribute.

[signal] void QNetworkReply::redirected(const QUrl &url)

Этот сигнал излучается, если в запросе был установлен атрибут QNetworkRequest::FollowRedirectsAttribute, и сервер ответил статусом 3xx (конкретно 301, 302, 303, 305, 307 или 308 код состояния) с допустимым URL в заголовке Location, указывая на HTTP-переадресацию. Параметр url содержит новый URL переадресации, возвращенный сервером в заголовке Location.

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

См. также QNetworkRequest::FollowRedirectsAttribute.

[signal] void QNetworkReply::sslErrors(const QList<QSslError> &errors)

Этот сигнал излучается, если сессия SSL/TLS столкнулась с ошибками во время настройки, включая ошибки проверки сертификатов. Параметр errors содержит список ошибок.

Чтобы указать, что ошибки не являются фатальными и что соединение должно быть продолжено, функция ignoreSslErrors() должна быть вызвана из слота, подключенного к этому сигналу. Если этого не сделать, сессия SSL будет разорвана до обмена данными (включая URL).

Этот сигнал может быть использован для отображения сообщения об ошибке пользователю, указывающего на потенциальную угрозу безопасности, и отображения настроек SSL (см. sslConfiguration() для получения настроек). Если пользователь решит продолжить после анализа удалённого сертификата, слот должен вызвать ignoreSslErrors().

См. также QSslSocket::sslErrors(), QNetworkAccessManager::sslErrors(), sslConfiguration() и ignoreSslErrors().

[signal] void QNetworkReply::uploadProgress(qint64 bytesSent, qint64 bytesTotal)

Этот сигнал излучается, чтобы указать прогресс загрузки в рамках этого сетевого запроса, если таковая имеется. Если с этим запросом не связана загрузка, этот сигнал не будет излучен.

Параметр bytesSent указывает количество отправленных байтов, а bytesTotal — общее количество байтов, которые должны быть отправлены. Если количество байтов для отправки определить невозможно, bytesTotal будет равно -1.

Загрузка завершается, когда bytesSent равно bytesTotal. В этот момент bytesTotal не будет равен -1.

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

[virtual] QNetworkReply::~QNetworkReply()

Удаляет этот ответ и освобождает все ресурсы, связанные с ним. Если какие-либо сетевые подключения по-прежнему открыты, они будут закрыты.

См. также abort() и close().

QVariant QNetworkReply::attribute(QNetworkRequest::Attribute code) const

Возвращает атрибут, связанный с кодом code. Если атрибут не был задан, возвращает недействительный QVariant (тип QMetaType::UnknownType).

Вы можете ожидать применения значений по умолчанию, указанных в QNetworkRequest::Attribute, к возвращаемым значениям этой функции.

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

[override virtual] void QNetworkReply::close()

Переопределяет: QIODevice::close().

Закрывает это устройство для чтения. Непрочитанные данные удаляются, но сетевые ресурсы не удаляются до завершения. В частности, если загрузка выполняется, она будет продолжена до завершения.

Сигнал finished() генерируется, когда все операции завершены и сетевые ресурсы освобождены.

См. также abort() и finished().

QNetworkReply::NetworkError QNetworkReply::error() const

Возвращает ошибку, которая была обнаружена во время обработки этого запроса. Если ошибка не была обнаружена, возвращает NoError.

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

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

Возвращает true если сырой заголовок с именем headerName был отправлен удаленным сервером

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

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

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

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

void QNetworkReply::ignoreSslErrors(const QList<QSslError> &errors)

Это перегруженная функция.

Если эта функция вызвана, ошибки SSL, указанные в errors, будут проигнорированы.

Примечание: Поскольку большинство ошибок SSL связаны с сертификатом, для большинства из них необходимо указать ожидаемый сертификат, связанный с этой ошибкой SSL. Если, например, вы хотите отправить запрос на сервер, использующий самозаверяющий сертификат, рассмотрите следующий фрагмент:

QList<QSslCertificate> cert = QSslCertificate::fromPath(QLatin1String("server-certificate.pem"));
QSslError error(QSslError::SelfSignedCertificate, cert.at(0));
QList<QSslError> expectedSslErrors;
expectedSslErrors.append(error);

QNetworkReply *reply = manager.get(QNetworkRequest(QUrl("https://server.tld/index.html")));
reply->ignoreSslErrors(expectedSslErrors);
// here connect signals etc.

Многократные вызовы этой функции заменят список ошибок, переданных в предыдущих вызовах. Вы можете очистить список ошибок, которые вы хотите проигнорировать, вызвав эту функцию со списком пустым списком.

Примечание: Если HTTP Strict Transport Security включён для QNetworkAccessManager, эта функция не имеет эффекта.

Эта функция была представлена в Qt 4.6.

См. также sslConfiguration(), sslErrors(), QSslSocket::ignoreSslErrors() и QNetworkAccessManager::setStrictTransportSecurityEnabled().

[virtual protected] void QNetworkReply::ignoreSslErrorsImplementation(const QList<QSslError> &errors)

Этот виртуальный метод предназначен для возможности переопределения поведения ignoreSslErrors(). ignoreSslErrors() — это публичная обёртка для этого метода. errors содержит ошибки, которые пользователь хочет игнорировать.

Эта функция была представлена в Qt 5.0.

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

bool QNetworkReply::isFinished() const

Возвращает true когда ответ завершён или был прерван.

Эта функция была представлена в Qt 4.6.

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

bool QNetworkReply::isRunning() const

Возвращает true когда запрос всё ещё обрабатывается, а ответ ещё не завершён или был прерван.

Эта функция была представлена в Qt 4.6.

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

QNetworkAccessManager *QNetworkReply::manager() const

Возвращает QNetworkAccessManager, который использовался для создания объекта QNetworkReply. Изначально это также родительский объект.

QNetworkAccessManager::Operation QNetworkReply::operation() const

Возвращает операцию, которая была отправлена для этого ответа.

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

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

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

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

QList<QByteArray> QNetworkReply::rawHeaderList() const

Возвращает список полей заголовков, отправленных удалённым сервером, в порядке их отправки. Повторяющиеся заголовки объединяются и занимают место последнего дубликата.

const QList<QNetworkReply::RawHeaderPair> &QNetworkReply::rawHeaderPairs() const

Возвращает список пар сырых заголовков.

qint64 QNetworkReply::readBufferSize() const

Возвращает размер буфера чтения в байтах.

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

QNetworkRequest QNetworkReply::request() const

Возвращает запрос, который был отправлен для этого ответа. Обратите внимание, что URL запроса может отличаться от URL ответа.

См. также QNetworkRequest::url(), url() и setRequest().

[protected] void QNetworkReply::setAttribute(QNetworkRequest::Attribute code, const QVariant &value)

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

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

[protected] void QNetworkReply::setError(QNetworkReply::NetworkError errorCode, const QString &errorString)

Устанавливает состояние ошибки на errorCode. Читабельное сообщение устанавливается с помощью errorString.

Вызов setError() не генерирует сигнал errorOccurred(QNetworkReply::NetworkError).

См. также error() и errorString().

[protected] void QNetworkReply::setFinished(bool finished)

Устанавливает ответ как finished.

После установки данных ответа не должны изменяться.

Эта функция была представлена в Qt 4.8.

См. также finished() и isFinished().

[protected] void QNetworkReply::setHeader(QNetworkRequest::KnownHeaders header, const QVariant &value)

Устанавливает известный заголовок header со значением value. Соответствующая исходная форма заголовка также будет установлена.

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

[protected] void QNetworkReply::setOperation(QNetworkAccessManager::Operation operation)

Устанавливает связанную операцию для данного объекта на operation. Это значение будет возвращено методом operation().

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

См. также operation() и setRequest().

[protected] void QNetworkReply::setRawHeader(const QByteArray &headerName, const QByteArray &value)

Устанавливает исходный заголовок headerName со значением value. Если headerName был ранее установлен, он будет перезаписан. Несколько HTTP-заголовков с одинаковым именем функционально эквивалентны одному заголовку со значениями, объединёнными запятыми.

Если headerName соответствует известному заголовку, значение value будет обработано, и соответствующая обработанная форма также будет установлена.

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

[virtual] void QNetworkReply::setReadBufferSize(qint64 size)

Устанавливает размер буфера чтения на size байт. Буфер чтения — это буфер, содержащий данные, загружаемые из сети, прежде чем они будут считаны методом QIODevice::read(). Установка размера буфера в 0 сделает буфер неограниченным по размеру.

QNetworkReply попытается остановить чтение из сети, когда этот буфер будет заполнен (т. е., bytesAvailable() вернёт size или больше), тем самым снизив скорость загрузки. Если буфер не ограничен по размеру, QNetworkReply будет пытаться загружать данные из сети с максимальной скоростью.

В отличие от QAbstractSocket::setReadBufferSize(), QNetworkReply не может гарантировать точность размера буфера чтения. То есть, bytesAvailable() может вернуть значение больше, чем size.

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

[protected] void QNetworkReply::setRequest(const QNetworkRequest &request)

Устанавливает связанный запрос для данного объекта на request. Это значение будет возвращено методом request().

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

См. также request() и setOperation().

void QNetworkReply::setSslConfiguration(const QSslConfiguration &config)

Устанавливает конфигурацию SSL для сетевого соединения, связанного с этим запросом, если это возможно, на конфигурацию config.

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

[virtual protected] void QNetworkReply::setSslConfigurationImplementation(const QSslConfiguration &configuration)

Этот виртуальный метод предоставлен для возможности переопределения поведения метода setSslConfiguration(). setSslConfiguration() является публичной оболочкой для этого метода. Если вы переопределите этот метод, используйте configuration для установки конфигурации SSL.

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

См. также sslConfigurationImplementation() и setSslConfiguration().

[protected] void QNetworkReply::setUrl(const QUrl &url)

Устанавливает URL обрабатываемого содержимого на url. Обычно URL соответствует URL запроса, но по различным причинам он может отличаться (например, путь к файлу может быть преобразован в абсолютный или канонический).

См. также url(), request(), и QNetworkRequest::url().

QSslConfiguration QNetworkReply::sslConfiguration() const

Возвращает конфигурацию и состояние SSL, связанное с этим ответом, если использовался SSL. Она будет содержать сертификат удалённого сервера, его цепочку сертификатов, ведущую к центру сертификации, а также используемые алгоритмы шифрования.

Сертификат клиента и его цепочка сертификатов будут известны к тому моменту, когда будет выведено событие sslErrors(), если оно выводится.

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

[virtual protected] void QNetworkReply::sslConfigurationImplementation(QSslConfiguration &configuration) const

Этот виртуальный метод предоставлен для возможности переопределения поведения метода sslConfiguration(). sslConfiguration() является публичной оболочкой для этого метода. Конфигурация будет возвращена в configuration.

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

См. также setSslConfigurationImplementation() и sslConfiguration().

QUrl QNetworkReply::url() const

Возвращает URL загруженного или загружаемого содержимого. Обратите внимание, что URL может отличаться от исходного URL запроса. Если в запросе был установлен атрибут QNetworkRequest::FollowRedirectsAttribute, этот метод возвращает текущий URL, к которому обращается сетевой API, т. е. URL, выводимый в сигнале QNetworkReply::redirected.

См. также request(), setUrl(), QNetworkRequest::url(), и redirected().