QNetworkReply Class

Documentation des fonctions membres

[explicit protected] QNetworkReply::QNetworkReply(QObject *parent = nullptr)

Crée un objet `QNetworkReply` dont le parent est ` parent`.

Vous ne pouvez pas instancier directement des objets QNetworkReply. Utilisez les fonctions d’ QNetworkAccessManager pour ce faire.

[virtual noexcept] QNetworkReply::~QNetworkReply()

Supprime cette réponse et libère toutes les ressources qui y sont associées. Si des connexions réseau sont encore ouvertes, elles seront fermées.

Voir également abort() et close().

[pure virtual slot] void QNetworkReply::abort()

Interrompt immédiatement l'opération et ferme toutes les connexions réseau encore ouvertes. Les transferts en cours sont également interrompus.

Le signal finished() sera également émis.

Voir également close() et finished().

QVariant QNetworkReply::attribute(QNetworkRequest::Attribute code) const

Renvoie l'attribut associé au code code. Si l'attribut n'a pas été défini, la fonction renvoie une valeur non valide QVariant (de type QMetaType::UnknownType).

Vous pouvez vous attendre à ce que les valeurs par défaut répertoriées dans QNetworkRequest::Attribute soient appliquées aux valeurs renvoyées par cette fonction.

Voir également setAttribute() et QNetworkRequest::Attribute.

[override virtual] void QNetworkReply::close()

Réimplémente : QIODevice::close().

Ferme ce périphérique en lecture. Les données non lues sont ignorées, mais les ressources réseau ne sont pas libérées tant que toutes les opérations ne sont pas terminées. En particulier, si un transfert en cours de chargement est en cours, celui-ci se poursuivra jusqu’à son achèvement.

Le signal ` finished()` est émis lorsque toutes les opérations sont terminées et que les ressources réseau sont libérées.

Voir également abort() et finished().

[signal] void QNetworkReply::downloadProgress(qint64 bytesReceived, qint64 bytesTotal)

Ce signal est émis pour indiquer la progression de la partie « téléchargement » de cette requête réseau, le cas échéant. Si aucune opération de téléchargement n’est associée à cette requête, ce signal sera émis une seule fois avec la valeur 0 pour les paramètres bytesReceived et bytesTotal.

Le paramètre bytesReceived indique le nombre d’octets reçus, tandis que bytesTotal indique le nombre total d’octets devant être téléchargés. Si le nombre d’octets à télécharger n’est pas connu, bytesTotal prendra la valeur -1.

Le téléchargement est terminé lorsque bytesReceived est égal à bytesTotal. À ce moment-là, bytesTotal ne sera plus égal à -1.

Notez que les valeurs de bytesReceived et de bytesTotal peuvent différer de size(), du nombre total d’octets obtenu via read() ou readAll(), ou encore de la valeur de l’en-tête (ContentLengthHeader). Cela s’explique par la présence éventuelle d’une surcharge liée au protocole ou par la compression des données pendant le téléchargement.

Voir également uploadProgress() et bytesAvailable().

[signal] void QNetworkReply::encrypted()

Ce signal est émis lorsqu'une session SSL/TLS a mené à bien la phase initiale d'établissement de la connexion. À ce stade, aucune donnée utilisateur n'a encore été transmise. Ce signal peut être utilisé pour effectuer des vérifications supplémentaires sur la chaîne de certificats, par exemple pour avertir les utilisateurs lorsque le certificat d’un site web a changé. Si la réponse ne correspond pas aux critères attendus, elle doit être interrompue en appelant la méthode ` QNetworkReply::abort()` depuis un slot connecté à ce signal. La configuration SSL en cours d’utilisation peut être consultée à l’aide de la méthode ` QNetworkReply::sslConfiguration()`.

En interne, ` QNetworkAccessManager ` peut ouvrir plusieurs connexions vers un serveur afin de permettre le traitement parallèle des requêtes. Ces connexions peuvent être réutilisées, ce qui signifie que le signal `encrypted()` ne sera pas émis. Vous avez donc la garantie de recevoir ce signal uniquement lors de la première connexion à un site au cours du cycle de vie de ` QNetworkAccessManager`.

Voir également QSslSocket::encrypted() et QNetworkAccessManager::encrypted().

QNetworkReply::NetworkError QNetworkReply::error() const

Renvoie l'erreur détectée lors du traitement de cette requête. Si aucune erreur n'a été détectée, renvoie « NoError ».

Voir également setError().

[signal] void QNetworkReply::errorOccurred(QNetworkReply::NetworkError code)

Ce signal est émis lorsque la réponse détecte une erreur lors du traitement. Le signal ` finished()` suivra probablement, indiquant que la connexion est terminée.

Le paramètre ` code ` contient le code de l'erreur détectée. Appelez ` errorString()` pour obtenir une représentation textuelle de l'erreur.

Voir également error() et errorString().

[signal] void QNetworkReply::finished()

Ce signal est émis lorsque le traitement de la réponse est terminé. Une fois ce signal émis, les données et métadonnées de la réponse ne feront plus l'objet d'aucune mise à jour.

À moins que les fonctions ` close()` ou ` abort()` n’aient été appelées, la réponse restera ouverte en lecture ; les données pourront donc être récupérées à l’aide des appels ` read()` ou ` readAll()`. En particulier, si aucun appel à ` read()` n’a été effectué à la suite de ` readyRead()`, un appel à ` readAll()` permettra de récupérer l’intégralité du contenu dans un objet ` QByteArray`.

Ce signal est émis conjointement avec QNetworkAccessManager::finished() lorsque le paramètre de réponse de ce signal est cet objet.

Vous pouvez également utiliser isFinished() pour vérifier si une QNetworkReply s’est terminée avant même de recevoir le signal finished().

Voir également setFinished(), QNetworkAccessManager::finished() et isFinished().

bool QNetworkReply::hasRawHeader(QAnyStringView headerName) const

Renvoie « true » si l'en-tête brut portant le nom « headerName » a été envoyé par le serveur distant.

Voir aussi rawHeader().

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

Renvoie la valeur de l'en-tête « header » (si cet en-tête a été envoyé par le serveur distant). Si l'en-tête n'a pas été envoyé, renvoie une valeur non valide « QVariant ».

Voir également rawHeader(), setHeader() et QNetworkRequest::header().

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

Renvoie les en-têtes qui ont été envoyés par le serveur distant.

Cette fonction a été introduite dans Qt 6.8.

Voir également setHeaders(), QNetworkRequest::setAttribute() et QNetworkRequest::Attribute.

[virtual slot] void QNetworkReply::ignoreSslErrors()

Si cette fonction est appelée, les erreurs SSL liées à la connexion réseau seront ignorées, y compris les erreurs de validation de certificat.

Cette fonction peut être appelée depuis le slot connecté au signal sslErrors(), qui indique quelles erreurs ont été détectées.

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        networkReply, qOverload<>(&QNetworkReply::ignoreSslErrors));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        networkReply, [receiver = networkReply]() { receiver->ignoreSslErrors(); });

Voir également sslConfiguration(), sslErrors() et QSslSocket::ignoreSslErrors().

void QNetworkReply::ignoreSslErrors(const QList<QSslError> &errors)

Si cette fonction est appelée, les erreurs SSL répertoriées à l'adresse errors seront ignorées.

QList<QSslCertificate> cert = QSslCertificate::fromPath("server-certificate.pem"_L1);
QSslError error(QSslError::SelfSignedCertificate, cert.at(0));
QList<QSslError> expectedSslErrors;
expectedSslErrors.append(error);

QNetworkReply *reply = manager.get(QNetworkRequest(QUrl("https://server.tld/index.html")));
reply->ignoreSslErrors(expectedSslErrors);
// here connect signals etc.

Les appels multiples à cette fonction remplaceront la liste des erreurs transmises lors des appels précédents. Vous pouvez effacer la liste des erreurs que vous souhaitez ignorer en appelant cette fonction avec une liste vide.

Voir également sslConfiguration(), sslErrors(), QSslSocket::ignoreSslErrors() et QNetworkAccessManager::setStrictTransportSecurityEnabled().

[virtual protected] void QNetworkReply::ignoreSslErrorsImplementation(const QList<QSslError> &errors)

Cette méthode virtuelle est fournie pour permettre de redéfinir le comportement de la méthode ` ignoreSslErrors()`. La méthode ` ignoreSslErrors()` est un wrapper public de cette méthode. La variable ` errors ` contient les erreurs que l'utilisateur souhaite ignorer.

Voir également ignoreSslErrors().

bool QNetworkReply::isFinished() const

Renvoie « true » lorsque la réponse est terminée ou a été interrompue.

Voir aussi isRunning().

bool QNetworkReply::isRunning() const

Renvoie « true » lorsque la requête est encore en cours de traitement et que la réponse n'est ni terminée ni interrompue.

Voir également isFinished().

[override virtual] bool QNetworkReply::isSequential() const

Réimplémente : QIODevice::isSequential() const.

QNetworkAccessManager *QNetworkReply::manager() const

Renvoie l'objet ` QNetworkAccessManager ` qui a servi à créer cet objet ` QNetworkReply `. Au départ, il s'agit également de l'objet parent.

[signal] void QNetworkReply::metaDataChanged()

Ce signal est émis chaque fois que les métadonnées contenues dans cette réponse changent. Les métadonnées désignent toute information autre que le contenu (les données) lui-même, y compris les en-têtes réseau. Dans la plupart des cas, les métadonnées seront entièrement connues dès la réception du premier octet de données. Il est toutefois possible de recevoir des mises à jour des en-têtes ou d’autres métadonnées pendant le traitement des données.

Voir également header(), rawHeaderList(), rawHeader() et hasRawHeader().

QNetworkAccessManager::Operation QNetworkReply::operation() const

Renvoie l'opération qui a été enregistrée pour cette réponse.

Voir également setOperation().

[signal] void QNetworkReply::preSharedKeyAuthenticationRequired(QSslPreSharedKeyAuthenticator *authenticator)

Ce signal est émis si la négociation SSL/TLS aboutit à un ensemble de chiffrements PSK, ce qui implique qu'une authentification PSK est alors requise.

Lorsqu'il utilise la méthode PSK, le client doit envoyer au serveur une identité valide et une clé pré-partagée valide pour que la négociation SSL puisse se poursuivre. Les applications peuvent fournir ces informations dans un slot connecté à ce signal, en remplissant l'objet ` authenticator ` transmis selon leurs besoins.

Voir également QSslPreSharedKeyAuthenticator.

QByteArray QNetworkReply::rawHeader(QAnyStringView headerName) const

Renvoie le contenu brut de l'en-tête « headerName » tel qu'il a été envoyé par le serveur distant. Si cet en-tête n'existe pas, renvoie un tableau d'octets vide, qui peut être impossible à distinguer d'un en-tête vide. Utilisez la fonction ` hasRawHeader()` pour vérifier si le serveur a envoyé ce champ d'en-tête.

Voir également setRawHeader(), hasRawHeader() et header().

QList<QByteArray> QNetworkReply::rawHeaderList() const

Renvoie une liste des champs d'en-tête envoyés par le serveur distant, dans l'ordre où ils ont été envoyés. Les en-têtes en double sont ignorés.

const QList<QNetworkReply::RawHeaderPair> &QNetworkReply::rawHeaderPairs() const

Renvoie une liste de paires d'en-têtes brutes.

qint64 QNetworkReply::readBufferSize() const

Renvoie la taille du tampon de lecture, en octets.

Voir aussi setReadBufferSize().

[signal] void QNetworkReply::redirectAllowed()

Lorsque le code client gérant le signal ` redirected()` a vérifié la nouvelle URL, il émet ce signal pour permettre la poursuite de la redirection. Ce protocole s'applique aux requêtes réseau dont la politique de redirection est définie sur QNetworkRequest::UserVerifiedRedirectPolicy

Voir également QNetworkRequest::UserVerifiedRedirectPolicy, QNetworkAccessManager::setRedirectPolicy() et QNetworkRequest::RedirectPolicyAttribute.

[signal] void QNetworkReply::redirected(const QUrl &url)

Ce signal est émis si l'en-tête « QNetworkRequest::ManualRedirectPolicy » n'a pas été défini dans la requête et que le serveur a renvoyé un code de statut 3xx (plus précisément les codes 301, 302, 303, 305, 307 ou 308) avec une URL valide dans l'en-tête « Location », indiquant une redirection HTTP. Le paramètre « url » contient la nouvelle URL de redirection telle qu’elle a été renvoyée par le serveur dans l’en-tête « Location ».

Voir également QNetworkRequest::RedirectPolicy.

QNetworkRequest QNetworkReply::request() const

Renvoie la requête qui a donné lieu à cette réponse. Notez notamment que l'URL de la requête peut être différente de celle de la réponse.

Voir également QNetworkRequest::url(), url() et setRequest().

[signal, since 6.3] void QNetworkReply::requestSent()

Ce signal est émis une ou plusieurs fois lorsque la requête a été envoyée. Utile pour la gestion personnalisée de la progression ou des délais d'expiration.

Cette fonction a été introduite dans Qt 6.3.

Voir également metaDataChanged() et socketStartedConnecting().

[protected] void QNetworkReply::setAttribute(QNetworkRequest::Attribute code, const QVariant &value)

Définit l'attribut « code » sur la valeur « value ». Si « code » était déjà défini, cette valeur sera remplacée. Si « value » correspond à une adresse QVariant non valide, l'attribut sera supprimé.

Voir également attribute() et QNetworkRequest::setAttribute().

[protected] void QNetworkReply::setError(QNetworkReply::NetworkError errorCode, const QString &errorString)

Définit la condition d'erreur sur « errorCode ». Le message lisible par l'utilisateur est défini à l'aide de « errorString ».

L’appel à setError() n’émet pas le signal errorOccurred(QNetworkReply::NetworkError).

Voir également error() et errorString().

[protected] void QNetworkReply::setFinished(bool finished)

Définit la réponse comme « finished ».

Une fois cette option définie, les données de la réponse ne doivent plus être modifiées.

Voir également finished() et isFinished().

[protected] void QNetworkReply::setHeader(QNetworkRequest::KnownHeaders header, const QVariant &value)

Définit la valeur de l'en-tête connu « header » sur « value ». La forme brute correspondante de l'en-tête sera également définie.

Voir également header(), setRawHeader() et QNetworkRequest::setHeader().

[protected, since 6.8] void QNetworkReply::setHeaders(const QHttpHeaders &newHeaders)

Définit les en-têtes suivants : newHeaders dans cette réponse réseau, en remplaçant tous les en-têtes précédemment définis.

Si certains en-têtes correspondent à des en-têtes connus, ils seront analysés et la forme analysée correspondante sera également définie.

Cette fonction a été introduite dans Qt 6.8.

Voir également headers() et QNetworkRequest::KnownHeaders.

[protected, since 6.8] void QNetworkReply::setHeaders(QHttpHeaders &&newHeaders)

Cette fonction a été introduite dans Qt 6.8.

[protected] void QNetworkReply::setOperation(QNetworkAccessManager::Operation operation)

Définit l'opération associée à cet objet sur « operation ». Cette valeur sera renvoyée par la fonction operation().

Voir également operation() et setRequest().

[protected] void QNetworkReply::setRawHeader(const QByteArray &headerName, const QByteArray &value)

Définit la valeur de l'en-tête brut headerName sur value. Si headerName avait été défini auparavant, il est remplacé. Plusieurs en-têtes HTTP portant le même nom sont fonctionnellement équivalents à un seul en-tête dont les valeurs sont concaténées, séparées par des virgules.

Si headerName correspond à un en-tête connu, la valeur value sera analysée et la forme analysée correspondante sera également définie.

Voir également rawHeader(), header(), setHeader() et QNetworkRequest::setRawHeader().

[virtual] void QNetworkReply::setReadBufferSize(qint64 size)

Définit la taille du tampon de lecture à size octets. Le tampon de lecture est le tampon qui stocke les données en cours de téléchargement depuis le réseau, avant qu’elles ne soient lues à l’aide de la fonction QIODevice::read(). Définir la taille du tampon sur 0 rendra celle-ci illimitée.

QNetworkReply essaiera d'arrêter la lecture depuis le réseau une fois ce tampon plein (c'est-à-dire lorsque bytesAvailable() renvoie size ou plus), ce qui entraînera également un ralentissement du téléchargement. Si la taille du tampon n'est pas limitée, QNetworkReply tentera de télécharger aussi rapidement que possible depuis le réseau.

Contrairement à QAbstractSocket::setReadBufferSize(), QNetworkReply ne peut pas garantir la précision de la taille du tampon de lecture. Autrement dit, bytesAvailable() peut renvoyer une valeur supérieure à size.

Voir également readBufferSize().

[protected] void QNetworkReply::setRequest(const QNetworkRequest &request)

Définit la requête associée à cet objet sur request. Cette valeur sera renvoyée par la fonction request().

Voir également request() et setOperation().

void QNetworkReply::setSslConfiguration(const QSslConfiguration &config)

Définit, si possible, la configuration SSL de la connexion réseau associée à cette requête afin qu'elle corresponde à celle de config.

Voir également sslConfiguration().

[virtual protected] void QNetworkReply::setSslConfigurationImplementation(const QSslConfiguration &configuration)

Cette méthode virtuelle est fournie pour permettre de redéfinir le comportement de la méthode setSslConfiguration(). La méthode setSslConfiguration() est un wrapper public de cette méthode. Si vous redéfinissez cette méthode, utilisez la méthode configuration pour définir la configuration SSL.

Voir également sslConfigurationImplementation() et setSslConfiguration().

[protected] void QNetworkReply::setUrl(const QUrl &url)

Définit l'URL en cours de traitement sur url. En règle générale, l'URL correspond à celle de la requête envoyée, mais elle peut, pour diverses raisons, être différente (par exemple, si un chemin d'accès à un fichier est rendu absolu ou canonique).

Voir également url(), request() et QNetworkRequest::url().

[protected, since 6.8] void QNetworkReply::setWellKnownHeader(QHttpHeaders::WellKnownHeader name, QByteArrayView value)

Définit la valeur de l'en-tête « name » sur « value ». Si « name » avait déjà été défini, cette valeur est remplacée.

Cette fonction a été introduite dans Qt 6.8.

[signal, since 6.3] void QNetworkReply::socketStartedConnecting()

Ce signal est émis zéro ou plusieurs fois, lors de l'établissement de la connexion par le socket, avant l'envoi de la requête. Utile pour la gestion personnalisée de la progression ou des délais d'expiration.

Cette fonction a été introduite dans Qt 6.3.

Voir également metaDataChanged() et requestSent().

QSslConfiguration QNetworkReply::sslConfiguration() const

Renvoie la configuration SSL et l'état associés à cette réponse, si le protocole SSL a été utilisé. Elle contiendra le certificat du serveur distant, sa chaîne de certificats menant à l'autorité de certification, ainsi que les algorithmes de chiffrement utilisés.

Le certificat du correspondant et sa chaîne de certificats seront connus au moment où la fonction ` sslErrors()` sera appelée, si celle-ci est appelée.

Voir également setSslConfiguration().

[virtual protected] void QNetworkReply::sslConfigurationImplementation(QSslConfiguration &configuration) const

Cette méthode virtuelle est fournie pour permettre de redéfinir le comportement de ` sslConfiguration()`. La méthode ` sslConfiguration()` est un wrapper public de cette méthode. La configuration sera renvoyée dans ` configuration`.

Voir également setSslConfigurationImplementation() et sslConfiguration().

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

Ce signal est émis si la session SSL/TLS a rencontré des erreurs lors de son établissement, notamment des erreurs de vérification de certificat. Le paramètre ` errors ` contient la liste des erreurs.

Pour indiquer que ces erreurs ne sont pas fatales et que la connexion doit se poursuivre, la fonction ignoreSslErrors() doit être appelée depuis le slot connecté à ce signal. Si elle n’est pas appelée, la session SSL sera interrompue avant tout échange de données (y compris l’URL).

Ce signal peut être utilisé pour afficher un message d’erreur à l’utilisateur indiquant que la sécurité pourrait être compromise et pour afficher les paramètres SSL (voir sslConfiguration() pour les obtenir). Si l’utilisateur décide de poursuivre après avoir analysé le certificat distant, le slot doit appeler ignoreSslErrors().

Voir également QSslSocket::sslErrors(), QNetworkAccessManager::sslErrors(), sslConfiguration() et ignoreSslErrors().

[signal] void QNetworkReply::uploadProgress(qint64 bytesSent, qint64 bytesTotal)

Ce signal est émis pour indiquer la progression de la partie « envoi » de cette requête réseau, le cas échéant. Si aucune opération d'envoi n'est associée à cette requête, ce signal ne sera pas émis.

Le paramètre bytesSent indique le nombre d’octets transférés, tandis que bytesTotal indique le nombre total d’octets à transférer. Si le nombre d’octets à transférer n’a pas pu être déterminé, bytesTotal prendra la valeur -1.

Le téléchargement est terminé lorsque bytesSent est égal à bytesTotal. À ce moment-là, bytesTotal ne sera plus égal à -1.

Voir également downloadProgress().

QUrl QNetworkReply::url() const

Renvoie l'URL du contenu téléchargé ou mis en ligne. Notez que cette URL peut être différente de celle de la requête d'origine. Si les redirections étaient activées dans la requête, cette fonction renvoie alors l'URL actuelle à laquelle l'API réseau accède, c'est-à-dire l'URL de la ressource vers laquelle la requête a été redirigée.

Voir également request(), setUrl(), QNetworkRequest::url() et redirected().

[override virtual protected] qint64 QNetworkReply::writeData(const char *data, qint64 len)

Réimplémentation de : QIODevice::writeData(const char *data, qint64 maxSize).