Класс QNetworkCookieJar

Класс QNetworkCookieJar реализует простой контейнер для объектов QNetworkCookie Подробнее...

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

Публичные функции

• 32 публичных функции, унаследованные от QObject

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

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

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

• 1 свойство, унаследованное от QObject
• 1 публичный слот, унаследованный от QObject
• 2 сигнала, унаследованные от QObject
• 11 статических публичных членов, унаследованных от QObject

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

Класс QNetworkCookieJar реализует простой контейнер для объектов QNetworkCookie

Куки — это небольшие фрагменты информации, которые используются в бессостоятельных протоколах, таких как HTTP, для хранения какой-либо постоянной информации между запросами.

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

Контейнер куки — это объект, хранящий все куки, установленные в предыдущих запросах. Веб-браузеры сохраняют свои контейнеры куки на диск, чтобы сохранять постоянные куки при повторных запусках приложения.

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

Этот класс реализует только базовые рекомендации по безопасности, заданные спецификациями куки, и не реализует никаких правил принятия куки (он принимает все куки, установленные любыми запросами). Для переопределения этих правил необходимо переопределить виртуальные функции cookiesForUrl() и setCookiesFromUrl(). Они вызываются QNetworkReply и QNetworkAccessManager при обнаружении новых куки и при необходимости получения куки.

См. также QNetworkCookie, QNetworkAccessManager, QNetworkReply, QNetworkRequest и QNetworkAccessManager::setCookieJar().

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

QNetworkCookieJar::QNetworkCookieJar(QObject *parent = Q_NULLPTR)

Создаёт объект QNetworkCookieJar и устанавливает родительский объект в parent.

Контейнер куки инициализируется пустым.

[virtual] QNetworkCookieJar::~QNetworkCookieJar()

Удаляет этот объект контейнера куки и удаляет все хранящиеся в нём куки. Куки не сохраняются на диск в стандартной реализации QNetworkCookieJar.

Если необходимо сохранить куки на диск, необходимо наследоваться от QNetworkCookieJar и сохранить куки на диск самостоятельно.

[protected] QList<QNetworkCookie> QNetworkCookieJar::allCookies() const

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

См. также setAllCookies() и cookiesForUrl().

[virtual] QList<QNetworkCookie> QNetworkCookieJar::cookiesForUrl(const QUrl &url) const

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

Если найдено более одного куки с одинаковым именем, но с разными путями, возвращается куки с более длинным путём перед куки с более коротким путём. Другими словами, эта функция возвращает куки, отсортированные по убыванию длины пути.

Стандартный класс QNetworkCookieJar реализует только очень базовую политику безопасности (он гарантирует, что домен и путь куки соответствуют ответу). Для повышения политики безопасности с помощью собственных алгоритмов переопределите cookiesForUrl().

См. также setCookiesFromUrl() и QNetworkAccessManager::setCookieJar().

[virtual] bool QNetworkCookieJar::deleteCookie(const QNetworkCookie &cookie)

Удаляет из контейнера куки куки, идентификатор которого совпадает с cookie.

Возвращает true если куки был удалён, иначе false.

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

См. также QNetworkCookie::hasSameIdentifier().

[virtual] bool QNetworkCookieJar::insertCookie(const QNetworkCookie &cookie)

Добавляет cookie в этот контейнер куки.

Возвращает true если cookie был добавлен, иначе false.

Если куки с таким же идентификатором уже существует в контейнере куки, он будет перезаписан.

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

[protected] void QNetworkCookieJar::setAllCookies(const QList<QNetworkCookie> &cookieList)

Устанавливает внутренний список куки, хранимых в этом контейнере куки, равным cookieList. Эта функция подходит для производных классов для реализации загрузки куки из постоянного хранилища или собственных правил принятия куки путём переопределения setCookiesFromUrl().

См. также allCookies() и setCookiesFromUrl().

[virtual] bool QNetworkCookieJar::setCookiesFromUrl(const QList<QNetworkCookie> &cookieList, const QUrl &url)

Добавляет куки из списка cookieList в этот контейнер куки. Перед вставкой куки нормализуются.

Возвращает true если один или несколько куки установлены для url, иначе false.

Если куки уже существует в контейнере куки, он будет перезаписан куками из cookieList.

Стандартный класс QNetworkCookieJar реализует только очень базовую политику безопасности (он гарантирует, что домен и путь куки соответствуют ответу). Для повышения политики безопасности с помощью собственных алгоритмов переопределите setCookiesFromUrl().

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

См. также cookiesForUrl(), QNetworkAccessManager::setCookieJar() и QNetworkCookie::normalize().

[virtual] bool QNetworkCookieJar::updateCookie(const QNetworkCookie &cookie)

Если в этом хранилище куки существует куки с таким же идентификатором, как и cookie, он будет обновлён. Эта функция использует insertCookie().

Возвращает true , если cookie был обновлён, false, если в хранилище нет куки, соответствующего идентификатору cookie.

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

См. также QNetworkCookie::hasSameIdentifier().

[virtual protected] bool QNetworkCookieJar::validateCookie(const QNetworkCookie &cookie, const QUrl &url) const

Возвращает true , если домен и путь cookie валидны, иначе — false. Параметр url используется для определения, разрешён ли домен, указанный в куки.

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