Класс QNetworkCookieJar

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

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

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

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

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

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

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

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

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

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

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

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

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

QNetworkCookieJar::QNetworkCookieJar(QObject *parent = 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 используется для определения, разрешен ли домен, указанный в cookie.

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