KanoopProtocolQt 1.2.3
Qt HTTP operations and MQTT client library
Loading...
Searching...
No Matches
HttpPut Class Reference

HTTP PUT operation executed asynchronously on a dedicated thread. More...

#include <httpput.h>

+ Inheritance diagram for HttpPut:
+ Collaboration diagram for HttpPut:

Public Member Functions

 HttpPut (const QString &url, const QByteArray &putBody=QByteArray())
 Construct an HTTP PUT operation with an optional raw body.
 
 HttpPut (const QString &url, const ISerializableToJson &putBody)
 Construct an HTTP PUT operation with a JSON-serializable body.
 
QByteArray putBody () const
 Return the PUT request body data.
 
- Public Member Functions inherited from HttpOperation
virtual ~HttpOperation ()
 Destructor.
 
QString url () const
 Return the target URL of this operation.
 
HttpKnownHeaders headers () const
 Return the known HTTP headers set on this operation.
 
HttpCustomHeaders customHeaders () const
 Return the custom HTTP headers set on this operation.
 
void appendHeader (QNetworkRequest::KnownHeaders type, const QByteArray &value)
 Append a known HTTP header to the request.
 
void appendHeader (const QString &headerName, const QByteArray &value)
 Append a custom HTTP header to the request.
 
void abortOperation ()
 Abort the running HTTP operation.
 
QList< QNetworkCookie > requestCookies () const
 Return the cookies to be sent with the request.
 
void setRequestCookies (const QList< QNetworkCookie > &value)
 Set the cookies to be sent with the request.
 
QList< QNetworkCookie > responseCookies () const
 Return the cookies received in the response.
 
bool isVerifyPeer () const
 Return whether peer SSL certificate verification is enabled.
 
void setVerifyPeer (bool value)
 Enable or disable peer SSL certificate verification.
 
bool isSelfSignedCertificateErrorIgnored () const
 Return whether self-signed certificate errors are being ignored.
 
void ignoreSelfSignedCertificate ()
 Configure the operation to ignore self-signed certificate errors.
 
TimeSpan transferTimeout () const
 Return the transfer timeout duration.
 
void setTransferTimeout (const TimeSpan &value)
 Set the transfer timeout duration.
 
QNetworkReply::NetworkError networkError () const
 Return the network error from the completed operation.
 
QString reasonPhrase () const
 Return the HTTP reason phrase from the response.
 
QByteArray responseBody () const
 Return the response body data.
 
int statusCode () const
 Return the HTTP status code from the response.
 
TimeSpan duration () const
 Return the wall-clock duration of the HTTP operation.
 
QString getRequestMethodString () const
 Return a human-readable string for this operation's request method.
 
bool isHttps () const
 Return whether this operation uses HTTPS.
 

Protected Member Functions

virtual void execute () override
 Execute the HTTP PUT request.
 
virtual void prePutHook ()
 Hook called before the PUT request is sent.
 
virtual void postPutHook ()
 Hook called after the PUT reply is received.
 
- Protected Member Functions inherited from HttpOperation
 HttpOperation (const QString &url, RequestMethod method)
 Construct an HTTP operation for the given URL and request method.
 
virtual void postReplyHook (QNetworkReply *)
 Hook called after the network reply is received.
 
void setUrl (const QString &value)
 Set the target URL of this operation.
 
QNetworkAccessManager * networkAccessManager ()
 Return the shared network access manager, creating it if necessary.
 
void setReply (QNetworkReply *reply)
 Store the network reply and connect its signals.
 
void appendHeadersToRequest (QNetworkRequest *request)
 Append all configured headers to the given network request.
 
void configureSsl (QNetworkRequest *request)
 Configure SSL settings on the given network request.
 
virtual void threadFinished () override
 Called when the operation thread finishes.
 

Additional Inherited Members

- Public Types inherited from HttpOperation
enum  RequestMethod {
  UnknownMethod = 0x0000 , Get = 0x0001 , Put = 0x0002 , Delete = 0x0004 ,
  Post = 0x0008 , Head = 0x0010 , Patch = 0x0040 , MultipartUpload = 0x1000
}
 Enumeration of supported HTTP request methods. More...
 
- Signals inherited from HttpOperation
void operationComplete ()
 Emitted when the HTTP operation has completed.
 
- Static Public Member Functions inherited from HttpOperation
static QString getRequestMethodString (RequestMethod method)
 Return a human-readable string for the given request method.
 
- Protected Slots inherited from HttpOperation
void onReplyFinished ()
 Handle the network reply finished signal.
 
void onSslErrors (const QList< QSslError > &errors)
 Handle SSL errors from the network reply.
 
void onReplyError (QNetworkReply::NetworkError error)
 Handle a network error from the reply.
 

Detailed Description

HTTP PUT operation executed asynchronously on a dedicated thread.

Definition at line 7 of file httpput.h.

Constructor & Destructor Documentation

◆ HttpPut() [1/2]

HttpPut::HttpPut ( const QString &  url,
const QByteArray &  putBody = QByteArray() 
)
inline

Construct an HTTP PUT operation with an optional raw body.

Parameters
urlThe target URL.
putBodyThe raw PUT body data.

Definition at line 14 of file httpput.h.

◆ HttpPut() [2/2]

HttpPut::HttpPut ( const QString &  url,
const ISerializableToJson &  putBody 
)
inline

Construct an HTTP PUT operation with a JSON-serializable body.

Parameters
urlThe target URL.
putBodyThe object to serialize to JSON for the PUT body.

Definition at line 21 of file httpput.h.

Member Function Documentation

◆ execute()

virtual void HttpPut::execute ( )
overrideprotectedvirtual

Execute the HTTP PUT request.

Implements HttpOperation.

◆ postPutHook()

virtual void HttpPut::postPutHook ( )
inlineprotectedvirtual

Hook called after the PUT reply is received.

Definition at line 37 of file httpput.h.

◆ prePutHook()

virtual void HttpPut::prePutHook ( )
inlineprotectedvirtual

Hook called before the PUT request is sent.

Definition at line 34 of file httpput.h.

◆ putBody()

QByteArray HttpPut::putBody ( ) const
inline

Return the PUT request body data.

Returns
The PUT body as a byte array.

Definition at line 27 of file httpput.h.


The documentation for this class was generated from the following file: