Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qhttpheaders.h
Go to the documentation of this file.
1// Copyright (C) 2023 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#ifndef QHTTPHEADERS_H
6#define QHTTPHEADERS_H
7
8#include <QtNetwork/qtnetworkglobal.h>
9
10#include <QtCore/qdatetime.h>
11#include <QtCore/qmetaobject.h>
12#include <QtCore/qobjectdefs.h>
13#include <QtCore/qshareddata.h>
14#include <QtCore/qcontainerfwd.h>
15
16QT_BEGIN_NAMESPACE
17
18class QDebug;
19
20class QHttpHeadersPrivate;
21QT_DECLARE_QESDP_SPECIALIZATION_DTOR_WITH_EXPORT(QHttpHeadersPrivate, Q_NETWORK_EXPORT)
22class QHttpHeaders
23{
24 Q_GADGET_EXPORT(Q_NETWORK_EXPORT)
25public:
26 enum class WellKnownHeader {
27 // IANA Permanent status:
28 AIM,
29 Accept,
30 AcceptAdditions,
31 AcceptCH,
32 AcceptDatetime,
33 AcceptEncoding,
34 AcceptFeatures,
35 AcceptLanguage,
36 AcceptPatch,
37 AcceptPost,
38 AcceptRanges,
39 AcceptSignature,
40 AccessControlAllowCredentials,
41 AccessControlAllowHeaders,
42 AccessControlAllowMethods,
43 AccessControlAllowOrigin,
44 AccessControlExposeHeaders,
45 AccessControlMaxAge,
46 AccessControlRequestHeaders,
47 AccessControlRequestMethod,
48 Age,
49 Allow,
50 ALPN,
51 AltSvc,
52 AltUsed,
53 Alternates,
54 ApplyToRedirectRef,
55 AuthenticationControl,
56 AuthenticationInfo,
57 Authorization,
58 CacheControl,
59 CacheStatus,
60 CalManagedID,
61 CalDAVTimezones,
62 CapsuleProtocol,
63 CDNCacheControl,
64 CDNLoop,
65 CertNotAfter,
66 CertNotBefore,
67 ClearSiteData,
68 ClientCert,
69 ClientCertChain,
70 Close,
71 Connection,
72 ContentDigest,
73 ContentDisposition,
74 ContentEncoding,
75 ContentID,
76 ContentLanguage,
77 ContentLength,
78 ContentLocation,
79 ContentRange,
80 ContentSecurityPolicy,
81 ContentSecurityPolicyReportOnly,
82 ContentType,
83 Cookie,
84 CrossOriginEmbedderPolicy,
85 CrossOriginEmbedderPolicyReportOnly,
86 CrossOriginOpenerPolicy,
87 CrossOriginOpenerPolicyReportOnly,
88 CrossOriginResourcePolicy,
89 DASL,
90 Date,
91 DAV,
92 DeltaBase,
93 Depth,
94 Destination,
95 DifferentialID,
96 DPoP,
97 DPoPNonce,
98 EarlyData,
99 ETag,
100 Expect,
101 ExpectCT,
102 Expires,
103 Forwarded,
104 From,
105 Hobareg,
106 Host,
107 If,
108 IfMatch,
109 IfModifiedSince,
110 IfNoneMatch,
111 IfRange,
112 IfScheduleTagMatch,
113 IfUnmodifiedSince,
114 IM,
115 IncludeReferredTokenBindingID,
116 KeepAlive,
117 Label,
118 LastEventID,
119 LastModified,
120 Link,
121 Location,
122 LockToken,
123 MaxForwards,
124 MementoDatetime,
125 Meter,
126 MIMEVersion,
127 Negotiate,
128 NEL,
129 ODataEntityId,
130 ODataIsolation,
131 ODataMaxVersion,
132 ODataVersion,
133 OptionalWWWAuthenticate,
134 OrderingType,
135 Origin,
136 OriginAgentCluster,
137 OSCORE,
138 OSLCCoreVersion,
139 Overwrite,
140 PingFrom,
141 PingTo,
142 Position,
143 Prefer,
144 PreferenceApplied,
145 Priority,
146 ProxyAuthenticate,
147 ProxyAuthenticationInfo,
148 ProxyAuthorization,
149 ProxyStatus,
150 PublicKeyPins,
151 PublicKeyPinsReportOnly,
152 Range,
153 RedirectRef,
154 Referer,
155 Refresh,
156 ReplayNonce,
157 ReprDigest,
158 RetryAfter,
159 ScheduleReply,
160 ScheduleTag,
161 SecPurpose,
162 SecTokenBinding,
163 SecWebSocketAccept,
164 SecWebSocketExtensions,
165 SecWebSocketKey,
166 SecWebSocketProtocol,
167 SecWebSocketVersion,
168 Server,
169 ServerTiming,
170 SetCookie,
171 Signature,
172 SignatureInput,
173 SLUG,
174 SoapAction,
175 StatusURI,
176 StrictTransportSecurity,
177 Sunset,
178 SurrogateCapability,
179 SurrogateControl,
180 TCN,
181 TE,
182 Timeout,
183 Topic,
184 Traceparent,
185 Tracestate,
186 Trailer,
187 TransferEncoding,
188 TTL,
189 Upgrade,
190 Urgency,
191 UserAgent,
192 VariantVary,
193 Vary,
194 Via,
195 WantContentDigest,
196 WantReprDigest,
197 WWWAuthenticate,
198 XContentTypeOptions,
199 XFrameOptions,
200 // IANA Deprecated status:
201 AcceptCharset,
202 CPEPInfo,
203 Pragma,
204 ProtocolInfo,
205 ProtocolQuery,
206 };
207 Q_ENUM(WellKnownHeader)
208
209 Q_NETWORK_EXPORT QHttpHeaders() noexcept;
210 Q_NETWORK_EXPORT ~QHttpHeaders();
211
212 Q_NETWORK_EXPORT QHttpHeaders(const QHttpHeaders &other);
213 QHttpHeaders(QHttpHeaders &&other) noexcept = default;
214 Q_NETWORK_EXPORT QHttpHeaders &operator=(const QHttpHeaders &other);
215 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QHttpHeaders)
216 void swap(QHttpHeaders &other) noexcept { d.swap(other.d); }
217
218 Q_NETWORK_EXPORT bool append(QAnyStringView name, QAnyStringView value);
219 Q_NETWORK_EXPORT bool append(WellKnownHeader name, QAnyStringView value);
220
221 Q_NETWORK_EXPORT bool insert(qsizetype i, QAnyStringView name, QAnyStringView value);
222 Q_NETWORK_EXPORT bool insert(qsizetype i, WellKnownHeader name, QAnyStringView value);
223
224 Q_NETWORK_EXPORT bool replace(qsizetype i, QAnyStringView name, QAnyStringView newValue);
225 Q_NETWORK_EXPORT bool replace(qsizetype i, WellKnownHeader name, QAnyStringView newValue);
226
227 Q_NETWORK_EXPORT bool replaceOrAppend(QAnyStringView name, QAnyStringView newValue);
228 Q_NETWORK_EXPORT bool replaceOrAppend(WellKnownHeader name, QAnyStringView newValue);
229
230 Q_NETWORK_EXPORT bool contains(QAnyStringView name) const;
231 Q_NETWORK_EXPORT bool contains(WellKnownHeader name) const;
232
233 Q_NETWORK_EXPORT void clear();
234 Q_NETWORK_EXPORT void removeAll(QAnyStringView name);
235 Q_NETWORK_EXPORT void removeAll(WellKnownHeader name);
236 Q_NETWORK_EXPORT void removeAt(qsizetype i);
237
238 Q_NETWORK_EXPORT QByteArrayView value(QAnyStringView name, QByteArrayView defaultValue = {}) const noexcept;
239 Q_NETWORK_EXPORT QByteArrayView value(WellKnownHeader name, QByteArrayView defaultValue = {}) const noexcept;
240
241 Q_NETWORK_EXPORT QList<QByteArray> values(QAnyStringView name) const;
242 Q_NETWORK_EXPORT QList<QByteArray> values(WellKnownHeader name) const;
243
244 Q_NETWORK_EXPORT QByteArrayView valueAt(qsizetype i) const noexcept;
245 Q_NETWORK_EXPORT QLatin1StringView nameAt(qsizetype i) const noexcept;
246
247 Q_NETWORK_EXPORT QByteArray combinedValue(QAnyStringView name) const;
248 Q_NETWORK_EXPORT QByteArray combinedValue(WellKnownHeader name) const;
249
250 Q_NETWORK_EXPORT std::optional<qint64> intValue(QAnyStringView name) const noexcept;
251 Q_NETWORK_EXPORT std::optional<qint64> intValue(WellKnownHeader name) const noexcept;
252
253 Q_NETWORK_EXPORT std::optional<QList<qint64>> intValues(QAnyStringView name) const;
254 Q_NETWORK_EXPORT std::optional<QList<qint64>> intValues(WellKnownHeader name) const;
255
256 Q_NETWORK_EXPORT std::optional<qint64> intValueAt(qsizetype i) const noexcept;
257
258 Q_NETWORK_EXPORT std::optional<QDateTime> dateTimeValue(QAnyStringView name) const;
259 Q_NETWORK_EXPORT std::optional<QDateTime> dateTimeValue(WellKnownHeader name) const;
260
261 Q_NETWORK_EXPORT std::optional<QList<QDateTime>> dateTimeValues(QAnyStringView name) const;
262 Q_NETWORK_EXPORT std::optional<QList<QDateTime>> dateTimeValues(WellKnownHeader name) const;
263
264 Q_NETWORK_EXPORT std::optional<QDateTime> dateTimeValueAt(qsizetype i) const;
265
266 Q_NETWORK_EXPORT void setDateTimeValue(QAnyStringView name, const QDateTime &dateTime);
267 Q_NETWORK_EXPORT void setDateTimeValue(WellKnownHeader name, const QDateTime &dateTime);
268
269 Q_NETWORK_EXPORT QList<QPair<qint64, qint64>> rangeValue(bool *ok = nullptr) const;
270 Q_NETWORK_EXPORT void setRangeValue(const QList<QPair<qint64, qint64>> &ranges);
271
272 Q_NETWORK_EXPORT qsizetype size() const noexcept;
273 Q_NETWORK_EXPORT void reserve(qsizetype size);
274 bool isEmpty() const noexcept { return size() == 0; }
275
276 Q_NETWORK_EXPORT static QByteArrayView wellKnownHeaderName(WellKnownHeader name) noexcept;
277
278 Q_NETWORK_EXPORT static QHttpHeaders
279 fromListOfPairs(const QList<std::pair<QByteArray, QByteArray>> &headers);
280 Q_NETWORK_EXPORT static QHttpHeaders
281 fromMultiMap(const QMultiMap<QByteArray, QByteArray> &headers);
282 Q_NETWORK_EXPORT static QHttpHeaders
283 fromMultiHash(const QMultiHash<QByteArray, QByteArray> &headers);
284
285 Q_NETWORK_EXPORT QList<std::pair<QByteArray, QByteArray>> toListOfPairs() const;
286 Q_NETWORK_EXPORT QMultiMap<QByteArray, QByteArray> toMultiMap() const;
287 Q_NETWORK_EXPORT QMultiHash<QByteArray, QByteArray> toMultiHash() const;
288
289private:
290#ifndef QT_NO_DEBUG_STREAM
291 friend Q_NETWORK_EXPORT QDebug operator<<(QDebug debug, const QHttpHeaders &headers);
292#endif
293
294#ifndef QT_NO_DATASTREAM
295 friend Q_NETWORK_EXPORT QDataStream &operator<<(QDataStream &stream, const QHttpHeaders &headers);
296 friend Q_NETWORK_EXPORT QDataStream &operator>>(QDataStream &stream, QHttpHeaders &headers);
297#endif
298
299 Q_ALWAYS_INLINE void verify([[maybe_unused]] qsizetype pos = 0,
300 [[maybe_unused]] qsizetype n = 1) const
301 {
302 Q_ASSERT(pos >= 0);
303 Q_ASSERT(pos <= size());
304 Q_ASSERT(n >= 0);
305 Q_ASSERT(n <= size() - pos);
306 }
307 QExplicitlySharedDataPointer<QHttpHeadersPrivate> d;
308};
309
310Q_DECLARE_SHARED(QHttpHeaders)
311
312QT_END_NAMESPACE
313
314#endif // QHTTPHEADERS_H
QHttpHeaders::clear
Q_NETWORK_EXPORT void clear()
Clears all header entries.
Definition qhttpheaders.cpp:1908
QHttpHeaders::isEmpty
bool isEmpty() const noexcept
Returns true if the headers have size 0; otherwise returns false.
Definition qhttpheaders.h:274
QHttpHeaders::insert
Q_NETWORK_EXPORT bool insert(qsizetype i, QAnyStringView name, QAnyStringView value)
Inserts a header entry at index i, with name and value.
Definition qhttpheaders.cpp:1237
QHttpHeaders::contains
Q_NETWORK_EXPORT bool contains(QAnyStringView name) const
Returns whether the headers contain header with name.
Definition qhttpheaders.cpp:1342
QHttpHeaders::~QHttpHeaders
Q_NETWORK_EXPORT ~QHttpHeaders()
Disposes of the headers object.
QHttpHeaders::removeAll
Q_NETWORK_EXPORT void removeAll(QAnyStringView name)
Removes the header name.
Definition qhttpheaders.cpp:1366
QHttpHeaders::setRangeValue
Q_NETWORK_EXPORT void setRangeValue(const QList< QPair< qint64, qint64 > > &ranges)
Definition qhttpheaders.cpp:1796
QHttpHeaders::replaceOrAppend
Q_NETWORK_EXPORT bool replaceOrAppend(QAnyStringView name, QAnyStringView newValue)
Definition qhttpheaders.cpp:1325
QHttpHeaders::replace
Q_NETWORK_EXPORT bool replace(qsizetype i, QAnyStringView name, QAnyStringView newValue)
Replaces the header entry at index i, with name and newValue.
Definition qhttpheaders.cpp:1271
QHttpHeaders::reserve
Q_NETWORK_EXPORT void reserve(qsizetype size)
Attempts to allocate memory for at least size header entries.
Definition qhttpheaders.cpp:1837
QHttpHeaders::removeAt
Q_NETWORK_EXPORT void removeAt(qsizetype i)
Removes the header at index i.
Definition qhttpheaders.cpp:1392
QHttpHeaders::QHttpHeaders
QHttpHeaders(QHttpHeaders &&other) noexcept=default
Move-constructs the object from other, which will be left \l{isEmpty()}{empty}.
QHttpHeaders::setDateTimeValue
Q_NETWORK_EXPORT void setDateTimeValue(QAnyStringView name, const QDateTime &dateTime)
Definition qhttpheaders.cpp:1635
QHttpHeaders::append
Q_NETWORK_EXPORT bool append(WellKnownHeader name, QAnyStringView value)
Definition qhttpheaders.cpp:1219
QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qrandomaccessasyncfile_darwin.mm:17
unescapeMaxAge
static QByteArrayView unescapeMaxAge(QByteArrayView value)
Definition qhsts.cpp:292
isCTL
static bool isCTL(int c)
Definition qhsts.cpp:251
isLWS
static bool isLWS(int c)
Definition qhsts.cpp:259
isCHAR
static bool isCHAR(int c)
Definition qhsts.cpp:245
isTEXT
static bool isTEXT(char c)
Definition qhsts.cpp:274
isTOKEN
static bool isTOKEN(char c)
Definition qhsts.cpp:301
isSeparator
static bool isSeparator(char c)
Definition qhsts.cpp:281