Класс QNetworkCookie

Класс QNetworkCookie хранит один сетевой cookie. Подробнее...

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

Типы публичного интерфейса

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

Статические публичные члены

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

Класс QNetworkCookie хранит один сетевой cookie.

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

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

QNetworkCookie хранит один такой cookie, полученный из сети. Cookie имеет имя и значение, но для приложения они являются непрозрачными (то есть информация, хранящаяся в них, не имеет смысла для приложения). У cookie также есть связанное имя пути и домен, которые указывают, когда cookie должен быть отправлен обратно на сервер.

Cookie также может иметь дату истечения срока действия, указывающую на его действительность. Если дата истечения срока действия отсутствует, cookie считается «cookie сессии» и должен быть удален при выходе приложения (или когда завершается его понятие сессии).

QNetworkCookie предоставляет способ парсинга cookie из формата заголовка HTTP с помощью функции QNetworkCookie::parseCookies(). Однако, когда cookie получен в QNetworkReply, он уже распарсен.

Этот класс реализует cookies, как описано в исходном спецификации cookie от Netscape, которая несколько похожа на спецификацию RFC 2109, плюс "расширение HttpOnly". Более поздняя спецификация RFC 2965 (которая использует заголовок Set-Cookie2) не поддерживается.

См. также QNetworkCookieJar, QNetworkRequest и QNetworkReply.

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

перечисление QNetworkCookie::RawForm

Это перечисление используется с функцией toRawForm(), чтобы указать, какой формат cookie должен быть возвращён.

Обратите внимание, что только полная форма cookie может быть распарсена обратно в исходное содержимое.

См. также toRawForm() и parseCookies().

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

QNetworkCookie::QNetworkCookie(const QByteArray &name = QByteArray(), const QByteArray &value = QByteArray())

Создаёт новый объект QNetworkCookie, инициализируя имя cookie значением name, а его значение значением value.

Cookie является валидным только в том случае, если у него есть имя. Однако значение непрозрачно для приложения, и пустое значение может иметь значение для удалённого сервера.

QNetworkCookie::QNetworkCookie(const QNetworkCookie &other)

Создаёт новый объект QNetworkCookie путём копирования содержимого other.

QNetworkCookie::~QNetworkCookie()

Уничтожает объект QNetworkCookie.

QString QNetworkCookie::domain() const

Возвращает домен, связанный с этим cookie. Соответствует полю «domain» строки cookie.

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

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

QDateTime QNetworkCookie::expirationDate() const

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

Дата истечения срока действия соответствует параметрам записи «expires» в строке cookie.

См. также isSessionCookie() и setExpirationDate().

bool QNetworkCookie::hasSameIdentifier(const QNetworkCookie &other) const

Возвращает true если у данного cookie есть та же кортеж идентификатора, что и у other. Кортеж идентификатора состоит из имени, домена и пути.

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

bool QNetworkCookie::isHttpOnly() const

Возвращает true если для данного cookie включён флаг «HttpOnly».

Cookie с флагом «HttpOnly» может устанавливаться и извлекаться только сетевыми запросами и ответами; т.е., протоколом HTTP. Он недоступен для сценариев, выполняемых в браузерах.

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

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

bool QNetworkCookie::isSecure() const

Возвращает true если параметр «secure» был указан в строке cookie, в противном случае — false.

Secure cookie могут содержать конфиденциальную информацию и не должны повторно отправляться по незащищённым каналам связи.

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

bool QNetworkCookie::isSessionCookie() const

Возвращает true если данный cookie является cookie сессии. Cookie сессии — это cookie без даты истечения срока действия, что означает, что он должен быть удалён, когда заканчивается сессия приложения (обычно, при выходе из приложения).

См. также expirationDate() и setExpirationDate().

QByteArray QNetworkCookie::name() const

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

См. также setName() и value().

void QNetworkCookie::normalize(const QUrl &url)

Эта функция нормализует путь и домен cookie, если они были ранее пустыми. Параметр url используется для определения правильного домена и пути.

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

[static] QList<QNetworkCookie> QNetworkCookie::parseCookies(const QByteArray &cookieString)

Парсит строку cookie cookieString, полученную от ответа сервера в заголовке «Set-Cookie:». Если произошла ошибка при парсинге, функция возвращает пустой список.

Поскольку заголовок HTTP может устанавливать более одного cookie одновременно, эта функция возвращает QList<QNetworkCookie>, по одному для каждого проанализированного cookie.

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

QString QNetworkCookie::path() const

Возвращает путь, связанный с этим cookie. Это соответствует полю «path» строки cookie.

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

void QNetworkCookie::setDomain(const QString &domain)

Устанавливает домен, связанный с этим cookie, в domain.

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

void QNetworkCookie::setExpirationDate(const QDateTime &date)

Устанавливает дату истечения срока действия этого cookie на date. Установка недопустимой даты истечения срока действия для этого cookie означает, что это cookie сессии.

См. также isSessionCookie() и expirationDate().

void QNetworkCookie::setHttpOnly(bool enable)

Устанавливает флаг «HttpOnly» этого cookie на enable.

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

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

void QNetworkCookie::setName(const QByteArray &cookieName)

Устанавливает имя этого cookie в cookieName. Обратите внимание, что установка имени cookie на пустой QByteArray сделает этот cookie недопустимым.

См. также name() и value().

void QNetworkCookie::setPath(const QString &path)

Устанавливает путь, связанный с этим cookie, в path.

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

void QNetworkCookie::setSecure(bool enable)

Устанавливает флаг безопасности этого cookie на enable.

Secure cookie могут содержать конфиденциальную информацию и не должны повторно отправляться по незащищённым каналам связи.

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

void QNetworkCookie::setValue(const QByteArray &value)

Устанавливает значение этого cookie в value.

См. также value() и name().

void QNetworkCookie::swap(QNetworkCookie &other)

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

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

QByteArray QNetworkCookie::toRawForm(RawForm form = Full) const

Возвращает исходную форму этого QNetworkCookie. Возвращаемый QByteArray подходит для HTTP-заголовка, как в ответе сервера (заголовок Set-Cookie), так и в запросе клиента (заголовок Cookie). Вы можете выбрать один из двух форматов, используя form.

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

QByteArray QNetworkCookie::value() const

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

Пара name-value cookie считаются необработанными для приложения: т.е., их значения ничего не означают.

См. также setValue() и name().

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

Возвращает true если этот cookie не равен other.

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

QNetworkCookie &QNetworkCookie::operator=(QNetworkCookie &&other)

Оператор перемещающего присваивания.

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

Копирует содержимое объекта QNetworkCookie other в этот объект.

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

Возвращает true если этот cookie равен other. Эта функция возвращает true только если все поля cookie одинаковы.

Однако в некоторых контекстах два cookie с одинаковым именем могут считаться равными.

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

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