1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtNetwork module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QNETWORKREQUEST_H
43 #define QNETWORKREQUEST_H
44 
45 #include <QtCore/QSharedDataPointer>
46 #include <QtCore/QString>
47 #include <QtCore/QUrl>
48 #include <QtCore/QVariant>
49 
50 QT_BEGIN_HEADER
51 
52 QT_BEGIN_NAMESPACE
53 
54 QT_MODULE(Network)
55 
56 class QSslConfiguration;
57 
58 class QNetworkRequestPrivate;
59 class Q_NETWORK_EXPORT QNetworkRequest
60 {
61 public:
62     enum KnownHeaders {
63         ContentTypeHeader,
64         ContentLengthHeader,
65         LocationHeader,
66         LastModifiedHeader,
67         CookieHeader,
68         SetCookieHeader,
69         ContentDispositionHeader  // added for QMultipartMessage
70     };
71     enum Attribute {
72         HttpStatusCodeAttribute,
73         HttpReasonPhraseAttribute,
74         RedirectionTargetAttribute,
75         ConnectionEncryptedAttribute,
76         CacheLoadControlAttribute,
77         CacheSaveControlAttribute,
78         SourceIsFromCacheAttribute,
79         DoNotBufferUploadDataAttribute,
80         HttpPipeliningAllowedAttribute,
81         HttpPipeliningWasUsedAttribute,
82         CustomVerbAttribute,
83         CookieLoadControlAttribute,
84         AuthenticationReuseAttribute,
85         CookieSaveControlAttribute,
86         MaximumDownloadBufferSizeAttribute, // internal
87         DownloadBufferAttribute, // internal
88         SynchronousRequestAttribute, // internal
89 
90         User = 1000,
91         UserMax = 32767
92     };
93     enum CacheLoadControl {
94         AlwaysNetwork,
95         PreferNetwork,
96         PreferCache,
97         AlwaysCache
98     };
99     enum LoadControl {
100         Automatic = 0,
101         Manual
102     };
103 
104     enum Priority {
105         HighPriority = 1,
106         NormalPriority = 3,
107         LowPriority = 5
108     };
109 
110     explicit QNetworkRequest(const QUrl &url = QUrl());
111     QNetworkRequest(const QNetworkRequest &other);
112     ~QNetworkRequest();
113     QNetworkRequest &operator=(const QNetworkRequest &other);
114 
115     bool operator==(const QNetworkRequest &other) const;
116     inline bool operator!=(const QNetworkRequest &other) const
117     { return !operator==(other); }
118 
119     QUrl url() const;
120     void setUrl(const QUrl &url);
121 
122     // "cooked" headers
123     QVariant header(KnownHeaders header) const;
124     void setHeader(KnownHeaders header, const QVariant &value);
125 
126     // raw headers:
127     bool hasRawHeader(const QByteArray &headerName) const;
128     QList<QByteArray> rawHeaderList() const;
129     QByteArray rawHeader(const QByteArray &headerName) const;
130     void setRawHeader(const QByteArray &headerName, const QByteArray &value);
131 
132     // attributes
133     QVariant attribute(Attribute code, const QVariant &defaultValue = QVariant()) const;
134     void setAttribute(Attribute code, const QVariant &value);
135 
136 #ifndef QT_NO_OPENSSL
137     QSslConfiguration sslConfiguration() const;
138     void setSslConfiguration(const QSslConfiguration &configuration);
139 #endif
140 
141     void setOriginatingObject(QObject *object);
142     QObject *originatingObject() const;
143 
144     Priority priority() const;
145     void setPriority(Priority priority);
146 
147 private:
148     QSharedDataPointer<QNetworkRequestPrivate> d;
149     friend class QNetworkRequestPrivate;
150 };
151 
152 QT_END_NAMESPACE
153 
154 Q_DECLARE_METATYPE(QNetworkRequest)
155 
156 QT_END_HEADER
157 
158 #endif
159