Главная · Все пространства имен · Все классы · Основные классы · Классы по группам · Модули · Функции

Описание класса QNetworkAccessManager
[Модуль QtNetwork]

Класс QNetworkAccessManager позволяет приложению отправлять сетевые запросы и получать ответы Далее...

 #include <QNetworkAccessManager>

Унаследован от: QObject.

Замечание: все функции этого класса реентерабильны.

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

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

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

• enum Operation { HeadOperation, GetOperation, PutOperation, PostOperation }

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

• QNetworkAccessManager ( QObject * parent = 0 )
• ~QNetworkAccessManager ()
• QNetworkCookieJar * cookieJar () const
• QNetworkReply * get ( const QNetworkRequest & request )
• QNetworkReply * head ( const QNetworkRequest & request )
• QNetworkReply * post ( const QNetworkRequest & request, QIODevice * data )
• QNetworkReply * post ( const QNetworkRequest & request, const QByteArray & data )
• QNetworkProxy proxy () const
• QNetworkReply * put ( const QNetworkRequest & request, QIODevice * data )
• QNetworkReply * put ( const QNetworkRequest & request, const QByteArray & data )
• void setCookieJar ( QNetworkCookieJar * cookieJar )
• void setProxy ( const QNetworkProxy & proxy )

• 29 открытых функций, унаследованных от QObject

Сигналы

• void authenticationRequired ( QNetworkReply * reply, QAuthenticator * authenticator )
• void finished ( QNetworkReply * reply )
• void proxyAuthenticationRequired ( const QNetworkProxy & proxy, QAuthenticator * authenticator )
• void sslErrors ( QNetworkReply * reply, const QList<QSslError> & errors )

• 1 сигнал, унаследованный от QObject

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

• virtual QNetworkReply * createRequest ( Operation op, const QNetworkRequest & req, QIODevice * outgoingData = 0 )

• 7 защищенных функций, унаследованных от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 открытый слот, унаследованный от QObject
• 5 статических открытых членов, унаследованных от QObject

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

Класс QNetworkAccessManager позволяет приложению отправлять сетевые запросы и получать ответы.

API сетевого доступа создано вокруг объекта QNetworkAccessManager, который содержит общую конфигурацию и настройки для посылаемых запросов. Он содержит прокси и кэш, а также сигналы, связанные с ними, и сигналы ответов.

После создания объекта QNetworkAccessManager, приложение может посылать запросы по сети с его помощью. Методы в QNetworkAccessManager принимают запрос и, дополнительно, некоторые данные, которые будут отправлены, и возвращает объект QNetworkReply. В возвращаемом объекте находится большинство сигналов и полученные данные.

Простое скачивание из сети может быть выполнено следующим способом:

 QNetworkAccessManager *manager = new QNetworkAccessManager(this);
 connect(manager, SIGNAL(finished(QNetworkReply*)),
         this, SLOT(replyFinished(QNetworkReply*)));

 manager->get(QNetworkRequest(QUrl("http://www.trolltech.com")));

Когда слот replyFinished будет вызван, то принимаемый им параметр будет объект QNetworkReply, содержащий скачанные данные и метаданные (заголовки и т.д.).

Замечание: Слот отвечает за удаление объекта.

Более сложный пример, подразумевающий что диспетчер уже создан, будет следующий:

 QNetworkRequest request;
 request.setUrl("http://www.trolltech.com");
 request.setRawHeader("User-Agent", "MyOwnBrowser 1.0");

 QNetworkReply *reply = manager->get(request);
 connect(reply, SIGNAL(readyRead()), this, SLOT(slotReadyRead()));
 connect(reply, SIGNAL(error(QNetworkReply::NetworkError)),
         this, SLOT(slotError(QNetworkReply::NetworkError)));
 connect(reply, SIGNAL(sslErrors(QList<QSslError>)),
         this, SLOT(slotSslErrors(QList<QSslError)));

Смотрите также QNetworkRequest, QNetworkReply и QNetworkProxy.

Описание типов-членов

enum QNetworkAccessManager::Operation

Указывает операцию, обрабатывающую этот ответ.

Смотрите также QNetworkReply::operation().

Описание функций-членов

QNetworkAccessManager::QNetworkAccessManager ( QObject * parent = 0 )

Создаёт объект QNetworkAccessManager, который является центром API сетевого доступа и устанавливает parent в качестве родителя.

QNetworkAccessManager::~QNetworkAccessManager ()

Уничтожает объект QNetworkAccessManager и освобождает все ресурсы. Заметьте, что объекты QNetworkReply, возвращаемые из этого класса, являются его потомками, что означает что они будут они удалены вместе с ним если вы не вызовите для них QObject::setParent().

void QNetworkAccessManager::authenticationRequired ( QNetworkReply * reply, QAuthenticator * authenticator )   [signal]

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

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

Смотрите также proxyAuthenticationRequired().

QNetworkCookieJar * QNetworkAccessManager::cookieJar () const

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

Смотрите также setCookieJar().

QNetworkReply * QNetworkAccessManager::createRequest ( Operation op, const QNetworkRequest & req, QIODevice * outgoingData = 0 )   [virtual protected]

Возвращает новый объект QNetworkReply для управления операцией op и запросом req. Устройство outgoingData всегда равно 0 для запросов Get и Head, а переданное значение в операции post() и put() (переменные QByteArray передадутся как объект QBuffer).

Реализация по-умолчанию вызывает QNetworkCookieJar::cookiesForUrl() для архива куки, установленного в setCookieJar(), чтобы получить куки, готовые к отправке на удалённый сервер.

Возвращаемый объект должен быть в открытом состоянии.

void QNetworkAccessManager::finished ( QNetworkReply * reply )   [signal]

Этот сигнал вырабатывается когда ожидаемый сетевой ответ завершается. Параметр reply будет содержать указатель на ответ, который только что завершился. Этот сигнал вырабатывается вместе с сигналом QNetworkReply::finished().

Для получения подробной информации о статусе, в котором будет объект, смотрите QNetworkReply::finished().

Смотрите также QNetworkReply::finished() и QNetworkReply::error().

QNetworkReply * QNetworkAccessManager::get ( const QNetworkRequest & request )

Эта функция используется для размещения запроса на получение содержимого целевого запроса request. Это вызовет скачивание содержимого вместе со связанными с ним заголовки. Он возвращает новый объект QNetworkReply, открытый для чтения, который вырабатывает свой сигнал QIODevice::readyRead() при получении новых данных.

Смотрите также post() и put().

QNetworkReply * QNetworkAccessManager::head ( const QNetworkRequest & request )

Эта функция используется для размещения запроса на получение сетевых заголовков для запроса request. Она получает своё имя после связанного запроса HTTP (HEAD). Она возвращает новый объект QNetworkReply, который будет содержать такие заголовки.

QNetworkReply * QNetworkAccessManager::post ( const QNetworkRequest & request, QIODevice * data )

Эта функция используется для отправления запроса HTTP POST получателю, указанному в request. Содержимое устройства data будет закачано на сервер.

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

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

Замечание: отправления запроса POST для протоколов кроме HTTP и HTTPS не определено и скорее всего не выполнится.

Смотрите также get() и put().

QNetworkReply * QNetworkAccessManager::post ( const QNetworkRequest & request, const QByteArray & data )

Это перегруженная функция, предоставленная для удобства.

Эта функция посылает массив байтов data получателю, указанному в request.

QNetworkProxy QNetworkAccessManager::proxy () const

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

Смотрите также setProxy() и proxyAuthenticationRequired().

void QNetworkAccessManager::proxyAuthenticationRequired ( const QNetworkProxy & proxy, QAuthenticator * authenticator )   [signal]

Этот сигнал вырабатывается когда прокси требует аутентификацию и QNetworkAccessManager не может найти годную кэшированную информацию. Слот, соединённый с этим сигналом, должен заполнять аутентификационную информацию для прокси proxy в объекте authenticator.

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

Если прокси отклонит эти данные, то QNetworkAccessManager выработает этот сигнал снова.

Смотрите также proxy(), setProxy() и authenticationRequired().

QNetworkReply * QNetworkAccessManager::put ( const QNetworkRequest & request, QIODevice * data )

Эта функция используется для загрузки содержимого data получателю request.

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

Возвращаемый объект QNetworkReply будет открыт для ответа, но будет ли что-нибудь доступно для чтения зависит от протокола. Для HTTP, сервер может послать маленькую страничку в HTML, указывая что загрузка была успешной (или нет). Другие протоколы вероятно будут содержать данные в своих ответах.

Для HTTP, этот запрос отправит запрос PUT, что не разрешают большинство серверов. Механизмы загрузки форм, включая загружаемые через HTML формы файлы, использует механизм POST.

Смотрите также get() и post().

QNetworkReply * QNetworkAccessManager::put ( const QNetworkRequest & request, const QByteArray & data )

Это перегруженная функция, предоставленная для удобства.

Эта функция посылает массив байтов data получателю, указанному в request.

void QNetworkAccessManager::setCookieJar ( QNetworkCookieJar * cookieJar )

Устанавливает архив куки, который используются всеми посылаемыми запросами, использующими объект QNetworkAccessManager, равный cookieJar. Используйте эту функцию чтобы установить в качестве объекта архива куки класс, реализующий расширенные возможности, такие как сохранение куков в постоянном хранилище.

Заметьте, что QNetworkAccessManager становится владельцем cookieJar.

QNetworkAccessManager по умолчанию сам не реализует ни какую политику куков: он принимает все куки, посланные сервером, пока они правильно сформированы и отвечают минимальным требованиям безопасности (домен куки и путь совпадают домену и пути запроса). Чтобы реализовать вашу собственную политику безопасности, переопределите виртуальные функции QNetworkCookieJar::cookiesForUrl() и QNetworkCookieJar::setCookiesFromUrl(). Эти функции вызываются QNetworkAccessManager когда он определяет новую куку.

Смотрите также cookieJar(), QNetworkCookieJar::cookiesForUrl() и QNetworkCookieJar::setCookiesFromUrl().

void QNetworkAccessManager::setProxy ( const QNetworkProxy & proxy )

Устанавливает прокси, которая будет использована в последующих запросах, равной proxy. Это не влияет на запросы, которые уже были отосланы. Сигнал proxyAuthenticationRequired() будет выработан если прокси требует аутентификацию.

Смотрите также proxy() и proxyAuthenticationRequired().

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

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

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

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

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