diff options
author | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2020-05-27 19:03:52 +0200 |
---|---|---|
committer | Kitsune Ral <Kitsune-Ral@users.sf.net> | 2020-05-31 13:25:04 +0200 |
commit | cf4d3d7ed82e62b57a11fbc7f491535a761dc75c (patch) | |
tree | 3d6a5c7adb33f6750ede53151ff560ee2cc47e5e /lib/jobs/basejob.h | |
parent | dacc4a9727cb1c400b70ae2b9d470ce42c24ead3 (diff) | |
download | libquotient-cf4d3d7ed82e62b57a11fbc7f491535a761dc75c.tar.gz libquotient-cf4d3d7ed82e62b57a11fbc7f491535a761dc75c.zip |
Move around and format code
No functional changes here.
Diffstat (limited to 'lib/jobs/basejob.h')
-rw-r--r-- | lib/jobs/basejob.h | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/lib/jobs/basejob.h b/lib/jobs/basejob.h index 2049f59c..954b0777 100644 --- a/lib/jobs/basejob.h +++ b/lib/jobs/basejob.h @@ -170,6 +170,8 @@ public: * recommended to present a sample of raw data as "details" next to * error messages. Note that the default \p bytesAtMost value is * also tailored to UI cases. + * + * \sa rawData */ QString rawDataSample(int bytesAtMost = 65535) const; @@ -322,6 +324,7 @@ protected: * on retries. */ virtual void doPrepare(); + /*! Postprocessing after the network request has been sent * * This method is called every time the job receives a running @@ -331,13 +334,15 @@ protected: virtual void onSentRequest(QNetworkReply*); virtual void beforeAbandon(QNetworkReply*); - /** - * Used by gotReply() to check the received reply for general - * issues such as network errors or access denial. - * Returning anything except NoError/Success prevents - * further parseReply()/parseJson() invocation. + /*! \brief Check the pending or received reply for upfront issues + * + * This is invoked when headers are first received and also once + * the complete reply is obtained; the base implementation checks the HTTP + * headers to detect general issues such as network errors or access denial. + * It cannot read the response body (use parseReply/parseError to check + * for problems in the body). Returning anything except NoError/Success + * prevents further processing of the reply. * - * @param reply the reply received from the server * @return the result of checking the reply * * @see gotReply |