QNetworkRequest Class

Member Function Documentation

QNetworkRequest::QNetworkRequest()

Constructs a QNetworkRequest object with no URL to be requested. Use setUrl() to set one.

See also url() and setUrl().

[explicit] QNetworkRequest::QNetworkRequest(const QUrl &url)

Constructs a QNetworkRequest object with url as the URL to be requested.

See also url() and setUrl().

QNetworkRequest::QNetworkRequest(const QNetworkRequest &other)

Creates a copy of other.

[noexcept] QNetworkRequest::~QNetworkRequest()

Disposes of the QNetworkRequest object.

QVariant QNetworkRequest::attribute(QNetworkRequest::Attribute code, const QVariant &defaultValue = QVariant()) const

Returns the attribute associated with the code code. If the attribute has not been set, it returns defaultValue.

See also setAttribute() and QNetworkRequest::Attribute.

[since 6.2] qint64 QNetworkRequest::decompressedSafetyCheckThreshold() const

Returns the threshold for archive bomb checks.

If the decompressed size of a reply is smaller than this, Qt will simply decompress it, without further checking.

This function was introduced in Qt 6.2.

See also setDecompressedSafetyCheckThreshold().

bool QNetworkRequest::hasRawHeader(QAnyStringView headerName) const

Returns true if the raw header headerName is present in this network request.

See also rawHeader() and setRawHeader().

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

Returns the value of the known network header header if it is present in this request. If it is not present, returns QVariant() (i.e., an invalid variant).

See also KnownHeaders, rawHeader(), and setHeader().

[since 6.8] QHttpHeaders QNetworkRequest::headers() const

Returns headers that are set in this network request.

This function was introduced in Qt 6.8.

See also setHeaders().

[since 6.5] QHttp1Configuration QNetworkRequest::http1Configuration() const

Returns the current parameters that QNetworkAccessManager is using for the underlying HTTP/1 connection of this request.

This function was introduced in Qt 6.5.

See also setHttp1Configuration.

QHttp2Configuration QNetworkRequest::http2Configuration() const

Returns the current parameters that QNetworkAccessManager is using for this request and its underlying HTTP/2 connection. This is either a configuration previously set by an application or a default configuration.

The default values that QNetworkAccessManager is using are:

• Window size for connection-level flowcontrol is 2147483647 octets
• Window size for stream-level flowcontrol is 214748364 octets
• Max frame size is 16384

By default, server push is disabled, Huffman compression and string indexing are enabled.

See also setHttp2Configuration.

int QNetworkRequest::maximumRedirectsAllowed() const

Returns the maximum number of redirects allowed to be followed for this request.

See also setMaximumRedirectsAllowed().

QObject *QNetworkRequest::originatingObject() const

Returns a reference to the object that initiated this network request; returns nullptr if not set or the object has been destroyed.

See also setOriginatingObject().

QString QNetworkRequest::peerVerifyName() const

Returns the host name set for the certificate validation, as set by setPeerVerifyName. By default this returns a null string.

See also setPeerVerifyName.

QNetworkRequest::Priority QNetworkRequest::priority() const

Return the priority of this request.

See also setPriority().

QByteArray QNetworkRequest::rawHeader(QAnyStringView headerName) const

Returns the raw form of header headerName. If no such header is present, an empty QByteArray is returned, which may be indistinguishable from a header that is present but has no content (use hasRawHeader() to find out if the header exists or not).

Raw headers can be set with setRawHeader() or with setHeader().

See also header() and setRawHeader().

QList<QByteArray> QNetworkRequest::rawHeaderList() const

Returns a list of all raw headers that are set in this network request. The list is in the order that the headers were set.

See also hasRawHeader() and rawHeader().

void QNetworkRequest::setAttribute(QNetworkRequest::Attribute code, const QVariant &value)

Sets the attribute associated with code code to be value value. If the attribute is already set, the previous value is discarded. In special, if value is an invalid QVariant, the attribute is unset.

See also attribute() and QNetworkRequest::Attribute.

[since 6.2] void QNetworkRequest::setDecompressedSafetyCheckThreshold(qint64 threshold)

Sets the threshold for archive bomb checks.

Some supported compression algorithms can, in a tiny compressed file, encode a spectacularly huge decompressed file. This is only possible if the decompressed content is extremely monotonous, which is seldom the case for real files being transmitted in good faith: files exercising such insanely high compression ratios are typically payloads of buffer-overrun attacks, or denial-of-service (by using up too much memory) attacks. Consequently, files that decompress to huge sizes, particularly from tiny compressed forms, are best rejected as suspected malware.

If a reply's decompressed size is bigger than this threshold (by default, 10 MiB, i.e. 10 * 1024 * 1024), Qt will check the compression ratio: if that is unreasonably large (40:1 for GZip and Deflate, or 100:1 for Brotli and ZStandard), the reply will be treated as an error. Setting the threshold to -1 disables this check.

This function was introduced in Qt 6.2.

See also decompressedSafetyCheckThreshold().

void QNetworkRequest::setHeader(QNetworkRequest::KnownHeaders header, const QVariant &value)

Sets the value of the known header header to be value, overriding any previously set headers. This operation also sets the equivalent raw HTTP header.

See also KnownHeaders, setRawHeader(), and header().

[since 6.8] void QNetworkRequest::setHeaders(QHttpHeaders &&newHeaders)

Sets newHeaders as headers in this network request, overriding any previously set headers.

If some headers correspond to the known headers, the values will be parsed and the corresponding parsed form will also be set.

This function was introduced in Qt 6.8.

See also headers() and KnownHeaders.

[since 6.8] void QNetworkRequest::setHeaders(const QHttpHeaders &newHeaders)

This is an overloaded function.

This function was introduced in Qt 6.8.

[since 6.5] void QNetworkRequest::setHttp1Configuration(const QHttp1Configuration &configuration)

Sets request's HTTP/1 parameters from configuration.

This function was introduced in Qt 6.5.

See also http1Configuration, QNetworkAccessManager, and QHttp1Configuration.

void QNetworkRequest::setHttp2Configuration(const QHttp2Configuration &configuration)

Sets request's HTTP/2 parameters from configuration.

See also http2Configuration, QNetworkAccessManager, and QHttp2Configuration.

void QNetworkRequest::setMaximumRedirectsAllowed(int maxRedirectsAllowed)

Sets the maximum number of redirects allowed to be followed for this request to maxRedirectsAllowed.

See also maximumRedirectsAllowed().

void QNetworkRequest::setOriginatingObject(QObject *object)

Allows setting a reference to the object initiating the request.

For example Qt WebKit sets the originating object to the QWebFrame that initiated the request.

See also originatingObject().

void QNetworkRequest::setPeerVerifyName(const QString &peerName)

Sets peerName as host name for the certificate validation, instead of the one used for the TCP connection.

See also peerVerifyName.

void QNetworkRequest::setPriority(QNetworkRequest::Priority priority)

Set the priority of this request to priority.

See also priority().

void QNetworkRequest::setRawHeader(const QByteArray &headerName, const QByteArray &headerValue)

Sets the header headerName to be of value headerValue. If headerName corresponds to a known header (see QNetworkRequest::KnownHeaders), the raw format will be parsed and the corresponding "cooked" header will be set as well.

For example:

 request.setRawHeader(QByteArray("Last-Modified"), QByteArray("Sun, 06 Nov 1994 08:49:37 GMT"));

will also set the known header LastModifiedHeader to be the QDateTime object of the parsed date.

See also KnownHeaders, setHeader(), hasRawHeader(), and rawHeader().

void QNetworkRequest::setSslConfiguration(const QSslConfiguration &config)

Sets this network request's SSL configuration to be config. The settings that apply are the private key, the local certificate, the TLS protocol (e.g. TLS 1.3), the CA certificates and the ciphers that the SSL backend is allowed to use.

See also sslConfiguration() and QSslConfiguration::defaultConfiguration().

void QNetworkRequest::setTransferTimeout(int timeout)

Sets timeout as the transfer timeout in milliseconds.

See also setTransferTimeout(std::chrono::milliseconds), transferTimeout(), and transferTimeoutAsDuration().

[since 6.7] void QNetworkRequest::setTransferTimeout(std::chrono::milliseconds duration = DefaultTransferTimeout)

Sets the timeout duration to abort the transfer if no data is exchanged.

Transfers are aborted if no bytes are transferred before the timeout expires. Zero means no timer is set. If no argument is provided, the timeout is QNetworkRequest::DefaultTransferTimeout. If this function is not called, the timeout is disabled and has the value zero.

This function was introduced in Qt 6.7.

See also transferTimeoutAsDuration().

void QNetworkRequest::setUrl(const QUrl &url)

Sets the URL this network request is referring to be url.

See also url().

QSslConfiguration QNetworkRequest::sslConfiguration() const

Returns this network request's SSL configuration. By default this is the same as QSslConfiguration::defaultConfiguration().

See also setSslConfiguration() and QSslConfiguration::defaultConfiguration().

[noexcept] void QNetworkRequest::swap(QNetworkRequest &other)

Swaps this network request with other. This function is very fast and never fails.

int QNetworkRequest::transferTimeout() const

Returns the timeout used for transfers, in milliseconds.

If transferTimeoutAsDuration().count() cannot be represented in int, this function returns INT_MAX/INT_MIN instead.

See also setTransferTimeout() and transferTimeoutAsDuration().

[since 6.7] std::chrono::milliseconds QNetworkRequest::transferTimeoutAsDuration() const

Returns the timeout duration after which the transfer is aborted if no data is exchanged.

The default duration is zero, which means that the timeout is not used.

This function was introduced in Qt 6.7.

See also setTransferTimeout(std::chrono::milliseconds).

QUrl QNetworkRequest::url() const

Returns the URL this network request is referring to.

See also setUrl().

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

Returns false if this object is not the same as other.

See also operator==().

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

Creates a copy of other

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

Returns true if this object is the same as other (i.e., if they have the same URL, same headers and same meta-data settings).

See also operator!=().