1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update QRestAccessManager documentation

Browse Source 
To accommodate the deduplication and non-owning changes
in previous commit.

Resulted from API-review

Change-Id: I61eb071503d6714c7fd42b3fe533698a8dcd2e27
Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
(cherry picked from commit 26d1e0e83e8467b292fd0abb0a563bb914b9b609)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Juha Vuolle 2024-01-25 10:47:11 +02:00 committed by Qt Cherry-pick Bot
parent 7fd767478a
commit 0ea24c99eb
3 changed files with 92 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/network/access/qnetworkrequestfactory.cpp
View File

@ -407,7 +407,7 @@ void QNetworkRequestFactory::clearPassword()
Sets \a timeout used for transfers. Sets \a timeout used for transfers.
\sa transferTimeout(), QNetworkRequest::setTransferTimeout(), \sa transferTimeout(), QNetworkRequest::setTransferTimeout(),
QRestAccessManager::setTransferTimeout() QNetworkAccessManager::setTransferTimeout()
*/ */
void QNetworkRequestFactory::setTransferTimeout(std::chrono::milliseconds timeout) void QNetworkRequestFactory::setTransferTimeout(std::chrono::milliseconds timeout)
{ {
@ -422,7 +422,7 @@ void QNetworkRequestFactory::setTransferTimeout(std::chrono::milliseconds timeou
Returns the timeout used for transfers. Returns the timeout used for transfers.
\sa setTransferTimeout(), QNetworkRequest::transferTimeout(), \sa setTransferTimeout(), QNetworkRequest::transferTimeout(),
QRestAccessManager::transferTimeout() QNetworkAccessManager::transferTimeout()
*/ */
std::chrono::milliseconds QNetworkRequestFactory::transferTimeout() const std::chrono::milliseconds QNetworkRequestFactory::transferTimeout() const
{ {

166
src/network/access/qrestaccessmanager.cpp
View File

@ -23,8 +23,8 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
/*! /*!
\class QRestAccessManager \class QRestAccessManager
\brief The QRestAccessManager is a networking convenience class for RESTful \brief The QRestAccessManager is a convenience wrapper for
client applications. QNetworkAccessManager.
\since 6.7 \since 6.7
\ingroup network \ingroup network
@ -33,17 +33,13 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\preliminary \preliminary
QRestAccessManager provides a networking API for typical REST client QRestAccessManager is a convenience wrapper on top of
applications. It provides the means to issue HTTP requests such as GET QNetworkAccessManager. It amends datatypes and HTTP methods
and POST. The responses to these requests can be handled with traditional that are useful for typical RESTful client applications.
Qt signal and slot mechanisms, as well as by providing callbacks
directly - see \l {Issuing Network Requests and Handling Replies}.
The class is a wrapper on top of QNetworkAccessManager, and it both amends The usual Qt networking features are accessible by configuring the
convenience methods and omits typically less used features. These wrapped QNetworkAccessManager directly. QRestAccessManager does not
features are still accessible by configuring the underlying take ownership of the wrapped QNetworkAccessManager.
QNetworkAccessManager directly. QRestAccessManager is closely related to
the QRestReply class, which it returns when issuing network requests.
QRestAccessManager and related QRestReply classes can only be used in the QRestAccessManager and related QRestReply classes can only be used in the
thread they live in. For further information see thread they live in. For further information see
@ -56,7 +52,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\section2 Using Signals and Slots \section2 Using Signals and Slots
The function returns a QRestReply* object, whose signals can be used The function returns a QNetworkReply* object, whose signals can be used
to follow up on the completion of the request in a traditional to follow up on the completion of the request in a traditional
Qt-signals-and-slots way. Qt-signals-and-slots way.
@ -68,11 +64,11 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\section2 Using Callbacks and Context Objects \section2 Using Callbacks and Context Objects
The functions also take a context object of QObject (subclass) type The functions also take a context object of QObject (subclass) type
and a callback function as parameters. The callback takes one QRestReply* and a callback function as parameters. The callback takes one QRestReply&
as a parameter. The callback can be any callable, incl. a as a parameter. The callback can be any callable, including a
pointer-to-member-function.. pointer-to-member-function.
These callbacks are invoked when the QRestReply has finished processing These callbacks are invoked when the reply has finished processing
(also in the case the processing finished due to an error). (also in the case the processing finished due to an error).
The context object can be \c nullptr, although, generally speaking, The context object can be \c nullptr, although, generally speaking,
@ -94,6 +90,11 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\snippet code/src_network_access_qrestaccessmanager.cpp 2 \snippet code/src_network_access_qrestaccessmanager.cpp 2
The provided QRestReply& is valid only while the callback
executes. If you need it for longer, you can either move it
to another QRestReply, or construct a new one and initialize
it with the QNetworkReply (see QRestReply::networkReply()).
\section2 Supported data types \section2 Supported data types
The following table summarizes the methods and the supported data types. The following table summarizes the methods and the supported data types.
@ -184,45 +185,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn void QRestAccessManager::authenticationRequired(QRestReply *reply, \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::get(
QAuthenticator *authenticator)
This signal is emitted when the final server requires authentication.
The authentication relates to the provided \a reply instance, and any
credentials are to be filled in the provided \a authenticator instance.
See \l QNetworkAccessManager::authenticationRequired() for details.
*/
/*!
\fn void QRestAccessManager::proxyAuthenticationRequired(
const QNetworkProxy &proxy, QAuthenticator *authenticator)
This signal is emitted when a proxy authentication requires action.
The proxy details are in \a proxy object, and any credentials are
to be filled in the provided \a authenticator object.
See \l QNetworkAccessManager::proxyAuthenticationRequired() for details.
*/
/*!
\fn void QRestAccessManager::requestFinished(QRestReply *reply)
This signal is emitted whenever a pending network reply is
finished. \a reply parameter will contain a pointer to the
reply that has just finished. This signal is emitted in tandem
with the QRestReply::finished() signal. QRestReply provides
functions for checking the status of the request, as well as for
acquiring any received data.
\note Do not delete \a reply object in the slot connected to this
signal. Use deleteLater() if needed. See also \l deletesRepliesOnFinished().
\sa QRestReply::finished()
*/
/*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::get(
const QNetworkRequest &request, const QNetworkRequest &request,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -234,16 +197,15 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\snippet code/src_network_access_qrestaccessmanager.cpp 3 \snippet code/src_network_access_qrestaccessmanager.cpp 3
Alternatively the signals of the returned QRestReply* object can be Alternatively the signals of the returned QNetworkReply* object can be
used. For further information see used. For further information see
\l {Issuing Network Requests and Handling Replies}. \l {Issuing Network Requests and Handling Replies}.
\sa QRestReply, QRestReply::finished(), \sa QRestReply
QRestAccessManager::requestFinished()
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::get( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::get(
const QNetworkRequest &request, const QByteArray &data, const QNetworkRequest &request, const QByteArray &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -255,16 +217,15 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\snippet code/src_network_access_qrestaccessmanager.cpp 4 \snippet code/src_network_access_qrestaccessmanager.cpp 4
Alternatively the signals of the returned QRestReply* object can be Alternatively the signals of the returned QNetworkReply* object can be
used. For further information see used. For further information see
\l {Issuing Network Requests and Handling Replies}. \l {Issuing Network Requests and Handling Replies}.
\sa QRestReply, QRestReply::finished(), \sa QRestReply
QRestAccessManager::requestFinished()
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::get( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::get(
const QNetworkRequest &request, const QJsonObject &data, const QNetworkRequest &request, const QJsonObject &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -273,7 +234,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::get( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::get(
const QNetworkRequest &request, QIODevice *data, const QNetworkRequest &request, QIODevice *data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -282,7 +243,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::post( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::post(
const QNetworkRequest &request, const QJsonObject &data, const QNetworkRequest &request, const QJsonObject &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -294,7 +255,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\snippet code/src_network_access_qrestaccessmanager.cpp 5 \snippet code/src_network_access_qrestaccessmanager.cpp 5
Alternatively, the signals of the returned QRestReply* object can be Alternatively, the signals of the returned QNetworkReply* object can be
used. For further information see used. For further information see
\l {Issuing Network Requests and Handling Replies}. \l {Issuing Network Requests and Handling Replies}.
@ -314,12 +275,11 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\c Content-Type header was not set \c Content-Type header was not set
**) QVariantMap is converted to and treated as a QJsonObject **) QVariantMap is converted to and treated as a QJsonObject
\sa QRestReply, QRestReply::finished(), \sa QRestReply
QRestAccessManager::requestFinished()
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::post( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::post(
const QNetworkRequest &request, const QJsonArray &data, const QNetworkRequest &request, const QJsonArray &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -328,7 +288,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::post( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::post(
const QNetworkRequest &request, const QVariantMap &data, const QNetworkRequest &request, const QVariantMap &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -337,7 +297,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::post( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::post(
const QNetworkRequest &request, const QByteArray &data, const QNetworkRequest &request, const QByteArray &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -346,7 +306,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::post( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::post(
const QNetworkRequest &request, QHttpMultiPart *data, const QNetworkRequest &request, QHttpMultiPart *data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -355,7 +315,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::post( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::post(
const QNetworkRequest &request, QIODevice *data, const QNetworkRequest &request, QIODevice *data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -364,7 +324,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::put( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::put(
const QNetworkRequest &request, const QJsonObject &data, const QNetworkRequest &request, const QJsonObject &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -376,7 +336,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\snippet code/src_network_access_qrestaccessmanager.cpp 6 \snippet code/src_network_access_qrestaccessmanager.cpp 6
Alternatively the signals of the returned QRestReply* object can be Alternatively the signals of the returned QNetworkReply* object can be
used. For further information see used. For further information see
\l {Issuing Network Requests and Handling Replies}. \l {Issuing Network Requests and Handling Replies}.
@ -396,11 +356,11 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\c Content-Type header was not set \c Content-Type header was not set
**) QVariantMap is converted to and treated as a QJsonObject **) QVariantMap is converted to and treated as a QJsonObject
\sa QRestReply, QRestReply::finished(), QRestAccessManager::requestFinished() \sa QRestReply
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::put( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::put(
const QNetworkRequest &request, const QJsonArray &data, const QNetworkRequest &request, const QJsonArray &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -409,7 +369,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::put( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::put(
const QNetworkRequest &request, const QVariantMap &data, const QNetworkRequest &request, const QVariantMap &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -418,7 +378,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::put( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::put(
const QNetworkRequest &request, const QByteArray &data, const QNetworkRequest &request, const QByteArray &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -427,7 +387,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::put( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::put(
const QNetworkRequest &request, QHttpMultiPart *data, const QNetworkRequest &request, QHttpMultiPart *data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -436,7 +396,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::put( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::put(
const QNetworkRequest &request, QIODevice *data, const QNetworkRequest &request, QIODevice *data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -445,7 +405,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::patch( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::patch(
const QNetworkRequest &request, const QJsonObject &data, const QNetworkRequest &request, const QJsonObject &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -457,7 +417,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\snippet code/src_network_access_qrestaccessmanager.cpp 10 \snippet code/src_network_access_qrestaccessmanager.cpp 10
Alternatively the signals of the returned QRestReply* object can be Alternatively the signals of the returned QNetworkReply* object can be
used. For further information see used. For further information see
\l {Issuing Network Requests and Handling Replies}. \l {Issuing Network Requests and Handling Replies}.
@ -476,11 +436,11 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\c Content-Type header was not set \c Content-Type header was not set
**) QVariantMap is converted to and treated as a QJsonObject **) QVariantMap is converted to and treated as a QJsonObject
\sa QRestReply, QRestReply::finished(), QRestAccessManager::requestFinished() \sa QRestReply
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::patch( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::patch(
const QNetworkRequest &request, const QJsonArray &data, const QNetworkRequest &request, const QJsonArray &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -489,7 +449,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::patch( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::patch(
const QNetworkRequest &request, const QVariantMap &data, const QNetworkRequest &request, const QVariantMap &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -498,7 +458,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::patch( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::patch(
const QNetworkRequest &request, const QByteArray &data, const QNetworkRequest &request, const QByteArray &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -507,7 +467,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::patch( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::patch(
const QNetworkRequest &request, QIODevice *data, const QNetworkRequest &request, QIODevice *data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -516,7 +476,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::head( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::head(
const QNetworkRequest &request, const QNetworkRequest &request,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -528,18 +488,17 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\snippet code/src_network_access_qrestaccessmanager.cpp 7 \snippet code/src_network_access_qrestaccessmanager.cpp 7
Alternatively the signals of the returned QRestReply* object can be Alternatively the signals of the returned QNetworkReply* object can be
used. For further information see used. For further information see
\l {Issuing Network Requests and Handling Replies}. \l {Issuing Network Requests and Handling Replies}.
\c head() request does not support providing data. \c head() request does not support providing data.
\sa QRestReply, QRestReply::finished(), \sa QRestReply
QRestAccessManager::requestFinished()
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::deleteResource( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::deleteResource(
const QNetworkRequest &request, const QNetworkRequest &request,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -551,18 +510,17 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\snippet code/src_network_access_qrestaccessmanager.cpp 8 \snippet code/src_network_access_qrestaccessmanager.cpp 8
Alternatively the signals of the returned QRestReply* object can be Alternatively the signals of the returned QNetworkReply* object can be
used. For further information see used. For further information see
\l {Issuing Network Requests and Handling Replies}. \l {Issuing Network Requests and Handling Replies}.
\c deleteResource() request does not support providing data. \c deleteResource() request does not support providing data.
\sa QRestReply, QRestReply::finished(), \sa QRestReply
QRestAccessManager::requestFinished()
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::sendCustomRequest( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::sendCustomRequest(
const QNetworkRequest& request, const QByteArray &method, const QByteArray &data, const QNetworkRequest& request, const QByteArray &method, const QByteArray &data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -575,14 +533,14 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
\snippet code/src_network_access_qrestaccessmanager.cpp 9 \snippet code/src_network_access_qrestaccessmanager.cpp 9
Alternatively the signals of the returned QRestReply* object can be Alternatively the signals of the returned QNetworkReply* object can be
used. For further information see used. For further information see
\l {Issuing Network Requests and Handling Replies}. \l {Issuing Network Requests and Handling Replies}.
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::sendCustomRequest( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::sendCustomRequest(
const QNetworkRequest& request, const QByteArray &method, QIODevice *data, const QNetworkRequest& request, const QByteArray &method, QIODevice *data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -591,7 +549,7 @@ Q_LOGGING_CATEGORY(lcQrest, "qt.network.access.rest")
*/ */
/*! /*!
\fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QRestReply *QRestAccessManager::sendCustomRequest( \fn template<typename Functor, QRestAccessManager::if_compatible_callback<Functor>> QNetworkReply *QRestAccessManager::sendCustomRequest(
const QNetworkRequest& request, const QByteArray &method, QHttpMultiPart *data, const QNetworkRequest& request, const QByteArray &method, QHttpMultiPart *data,
const ContextTypeForFunctor<Functor> *context, const ContextTypeForFunctor<Functor> *context,
Functor &&callback) Functor &&callback)
@ -609,15 +567,13 @@ QRestAccessManager::QRestAccessManager(QNetworkAccessManager *manager, QObject *
} }
/*! /*!
Destroys the QRestAccessManager object and frees up any Destroys the QRestAccessManager object.
resources, including any unfinished QRestReply objects.
*/ */
QRestAccessManager::~QRestAccessManager() QRestAccessManager::~QRestAccessManager()
= default; = default;
/*! /*!
Returns the underlying QNetworkAccessManager instance. The instance Returns the underlying QNetworkAccessManager instance.
can be used for accessing less-frequently used features and configurations.
\sa QNetworkAccessManager \sa QNetworkAccessManager
*/ */

53
src/network/doc/snippets/code/src_network_access_qrestaccessmanager.cpp
View File

@ -2,15 +2,20 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
//! [0] //! [0]
QRestReply *reply = manager->get(request); QNetworkReply *reply = manager->get(request);
QObject::connect(reply, &QRestReply::finished, this, &MyClass::handleFinished); QObject::connect(reply, &QNetworkReply::finished, this, [reply]() {
// The reply may be wrapped in the finish handler:
QRestReply restReply(reply);
if (restReply.isSuccess())
// ...
});
//! [0] //! [0]
//! [1] //! [1]
// With lambda // With lambda
manager->get(request, this, [this](QRestReply *reply) { manager->get(request, this, [this](QRestReply &reply) {
if (reply->isSuccess()) { if (reply.isSuccess()) {
// ... // ...
} }
}); });
@ -22,11 +27,11 @@ manager->get(request, this, &MyClass::handleFinished);
//! [2] //! [2]
QJsonObject myJson; QJsonObject myJson;
// ... // ...
manager->post(request, myJson, this, [this](QRestReply *reply) { manager->post(request, myJson, this, [this](QRestReply &reply) {
if (!reply->isSuccess()) { if (!reply.isSuccess()) {
// ... // ...
} }
if (std::optional json = reply->json()) { if (std::optional json = reply.json()) {
// use *json // use *json
} }
}); });
@ -34,66 +39,66 @@ manager->post(request, myJson, this, [this](QRestReply *reply) {
//! [3] //! [3]
manager->get(request, this, [this](QRestReply *reply) { manager->get(request, this, [this](QRestReply &reply) {
if (!reply->isSuccess()) if (!reply.isSuccess())
// handle error // handle error
if (std::optional json = reply->json()) if (std::optional json = reply.json())
// use *json // use *json
}); });
//! [3] //! [3]
//! [4] //! [4]
manager->get(request, myData, this, [this](QRestReply *reply) { manager->get(request, myData, this, [this](QRestReply &reply) {
if (reply->isSuccess()) if (reply.isSuccess())
// ... // ...
}); });
//! [4] //! [4]
//! [5] //! [5]
manager->post(request, myData, this, [this](QRestReply *reply) { manager->post(request, myData, this, [this](QRestReply &reply) {
if (reply->isSuccess()) if (reply.isSuccess())
// ... // ...
}); });
//! [5] //! [5]
//! [6] //! [6]
manager->put(request, myData, this, [this](QRestReply *reply) { manager->put(request, myData, this, [this](QRestReply &reply) {
if (reply->isSuccess()) if (reply.isSuccess())
// ... // ...
}); });
//! [6] //! [6]
//! [7] //! [7]
manager->head(request, this, [this](QRestReply *reply) { manager->head(request, this, [this](QRestReply &reply) {
if (reply->isSuccess()) if (reply.isSuccess())
// ... // ...
}); });
//! [7] //! [7]
//! [8] //! [8]
manager->deleteResource(request, this, [this](QRestReply *reply) { manager->deleteResource(request, this, [this](QRestReply &reply) {
if (reply->isSuccess()) if (reply.isSuccess())
// ... // ...
}); });
//! [8] //! [8]
//! [9] //! [9]
manager->sendCustomRequest(request, "MYMETHOD", myData, this, [this](QRestReply *reply) { manager->sendCustomRequest(request, "MYMETHOD", myData, this, [this](QRestReply &reply) {
if (reply->isSuccess()) if (reply.isSuccess())
// ... // ...
}); });
//! [9] //! [9]
//! [10] //! [10]
manager->patch(request, myData, this, [this](QRestReply *reply) { manager->patch(request, myData, this, [this](QRestReply &reply) {
if (reply->isSuccess()) if (reply.isSuccess())
// ... // ...
}); });
//! [10] //! [10]