1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qwebengineurlrequestjob.h"
#include "net/url_request_custom_job_proxy.h"
#include "net/url_request_custom_job_delegate.h"
using QtWebEngineCore::URLRequestCustomJobDelegate;
QT_BEGIN_NAMESPACE
/*!
\class QWebEngineUrlRequestJob
\brief The QWebEngineUrlRequestJob class represents a custom URL request.
\since 5.6
A QWebEngineUrlRequestJob is given to QWebEngineUrlSchemeHandler::requestStarted() and must
be handled by the derived implementations of the class. The job can be handled by calling
either reply(), redirect(), or fail().
The class is owned by the web engine and does not need to be deleted. However, the web engine
may delete the job when it is no longer needed, and therefore the signal QObject::destroyed()
must be monitored if a pointer to the object is stored.
\inmodule QtWebEngineCore
*/
/*!
\enum QWebEngineUrlRequestJob::Error
This enum type holds the type of the error that occurred:
\value NoError
The request was successful.
\value UrlNotFound
The requested URL was not found.
\value UrlInvalid
The requested URL is invalid.
\value RequestAborted
The request was canceled.
\value RequestDenied
The request was denied.
\value RequestFailed
The request failed.
*/
/*!
\internal
*/
QWebEngineUrlRequestJob::QWebEngineUrlRequestJob(URLRequestCustomJobDelegate *p)
: QObject(p) // owned by the jobdelegate and deleted when the job is done
, d_ptr(p)
{}
/*!
\internal
*/
QWebEngineUrlRequestJob::~QWebEngineUrlRequestJob()
{
}
/*!
Returns the requested URL.
*/
QUrl QWebEngineUrlRequestJob::requestUrl() const
{
return d_ptr->url();
}
/*!
Returns the HTTP method of the request (for example, GET or POST).
*/
QByteArray QWebEngineUrlRequestJob::requestMethod() const
{
return d_ptr->method();
}
/*!
\since 5.11
Returns the serialized origin of the content that initiated the request.
Generally, the origin consists of a scheme, hostname, and port. For example,
\c "http://localhost:8080" would be a valid origin. The port is omitted if
it is the scheme's default port (80 for \c http, 443 for \c https). The
hostname is omitted for non-network schemes such as \c file and \c qrc.
However, there is also the special value \c "null" representing a unique
origin. It is, for example, the origin of a sandboxed iframe. The purpose of
this special origin is to be always different from all other origins in the
same-origin check. In other words, content with a unique origin should never
have privileged access to any other content.
Finally, if the request was not initiated by web content, the function will
return an empty QUrl. This happens, for example, when you call \l
QWebEnginePage::setUrl().
This value can be used for implementing secure cross-origin checks.
*/
QUrl QWebEngineUrlRequestJob::initiator() const
{
return d_ptr->initiator();
}
/*!
\since 5.13
Returns any HTTP headers added to the request.
*/
QMap<QByteArray, QByteArray> QWebEngineUrlRequestJob::requestHeaders() const
{
return d_ptr->requestHeaders();
}
/*!
Returns a pointer to a QIODevice that gives access to the request body.
The request body can contain data for example when the request is
a POST request. If the request body is empty the QIODevice reflects this
and does not return any data when performing read operations on it.
\since 6.7
\sa QIODevice
*/
QIODevice *QWebEngineUrlRequestJob::requestBody() const
{
return d_ptr->requestBody();
}
/*!
\since 6.6
Set \a additionalResponseHeaders. These additional headers of the response
are only used when QWebEngineUrlRequestJob::reply(const QByteArray&, QIODevice*)
is called.
*/
void QWebEngineUrlRequestJob::setAdditionalResponseHeaders(
const QMultiMap<QByteArray, QByteArray> &additionalResponseHeaders) const
{
d_ptr->setAdditionalResponseHeaders(additionalResponseHeaders);
}
/*!
Replies to the request with \a device and the content type \a contentType.
Content type is similar to the HTTP Content-Type header, and can either be
a MIME type, or a MIME type and charset encoding combined like this:
"text/html; charset=utf-8".
The user has to be aware that \a device will be used on another thread
until the job is deleted. In case simultaneous access from the main thread
is desired, the user is reponsible for making access to \a device thread-safe
for example by using QMutex. Note that the \a device object is not owned by
the web engine. Therefore, the signal QObject::destroyed() of
QWebEngineUrlRequestJob must be monitored.
The device should remain available at least as long as the job exists.
When calling this method with a newly constructed device, one solution is to
make the device as a child of the job or delete itself when job is deleted,
like this:
\code
connect(job, &QObject::destroyed, device, &QObject::deleteLater);
\endcode
*/
void QWebEngineUrlRequestJob::reply(const QByteArray &contentType, QIODevice *device)
{
d_ptr->reply(contentType, device);
}
/*!
Fails the request with the error \a r.
\sa Error
*/
void QWebEngineUrlRequestJob::fail(Error r)
{
d_ptr->fail((URLRequestCustomJobDelegate::Error)r);
}
/*!
Redirects the request to \a url.
*/
void QWebEngineUrlRequestJob::redirect(const QUrl &url)
{
d_ptr->redirect(url);
}
QT_END_NAMESPACE
#include "moc_qwebengineurlrequestjob.cpp"
|
