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 QHTTPNETWORKREQUEST_H 43 #define QHTTPNETWORKREQUEST_H 44 45 // 46 // W A R N I N G 47 // ------------- 48 // 49 // This file is not part of the Qt API. It exists for the convenience 50 // of the Network Access API. This header file may change from 51 // version to version without notice, or even be removed. 52 // 53 // We mean it. 54 // 55 #ifndef QT_NO_HTTP 56 57 #include <private/qhttpnetworkheader_p.h> 58 59 QT_BEGIN_NAMESPACE 60 61 class QNonContiguousByteDevice; 62 63 class QHttpNetworkRequestPrivate; 64 class Q_AUTOTEST_EXPORT QHttpNetworkRequest: public QHttpNetworkHeader 65 { 66 public: 67 enum Operation { 68 Options, 69 Get, 70 Head, 71 Post, 72 Put, 73 Delete, 74 Trace, 75 Connect, 76 Custom 77 }; 78 79 enum Priority { 80 HighPriority, 81 NormalPriority, 82 LowPriority 83 }; 84 85 QHttpNetworkRequest(const QUrl &url = QUrl(), Operation operation = Get, Priority priority = NormalPriority); 86 QHttpNetworkRequest(const QHttpNetworkRequest &other); 87 virtual ~QHttpNetworkRequest(); 88 QHttpNetworkRequest &operator=(const QHttpNetworkRequest &other); 89 bool operator==(const QHttpNetworkRequest &other) const; 90 91 QUrl url() const; 92 void setUrl(const QUrl &url); 93 94 int majorVersion() const; 95 int minorVersion() const; 96 97 qint64 contentLength() const; 98 void setContentLength(qint64 length); 99 100 QList<QPair<QByteArray, QByteArray> > header() const; 101 QByteArray headerField(const QByteArray &name, const QByteArray &defaultValue = QByteArray()) const; 102 void setHeaderField(const QByteArray &name, const QByteArray &data); 103 104 Operation operation() const; 105 void setOperation(Operation operation); 106 107 QByteArray customVerb() const; 108 void setCustomVerb(const QByteArray &customOperation); 109 110 Priority priority() const; 111 void setPriority(Priority priority); 112 113 bool isPipeliningAllowed() const; 114 void setPipeliningAllowed(bool b); 115 116 bool withCredentials() const; 117 void setWithCredentials(bool b); 118 119 bool isSsl() const; 120 void setSsl(bool); 121 122 void setUploadByteDevice(QNonContiguousByteDevice *bd); 123 QNonContiguousByteDevice* uploadByteDevice() const; 124 125 private: 126 QSharedDataPointer<QHttpNetworkRequestPrivate> d; 127 friend class QHttpNetworkRequestPrivate; 128 friend class QHttpNetworkConnectionPrivate; 129 friend class QHttpNetworkConnectionChannel; 130 }; 131 132 class QHttpNetworkRequestPrivate : public QHttpNetworkHeaderPrivate 133 { 134 public: 135 QHttpNetworkRequestPrivate(QHttpNetworkRequest::Operation op, 136 QHttpNetworkRequest::Priority pri, const QUrl &newUrl = QUrl()); 137 QHttpNetworkRequestPrivate(const QHttpNetworkRequestPrivate &other); 138 ~QHttpNetworkRequestPrivate(); 139 bool operator==(const QHttpNetworkRequestPrivate &other) const; 140 QByteArray methodName() const; 141 QByteArray uri(bool throughProxy) const; 142 143 static QByteArray header(const QHttpNetworkRequest &request, bool throughProxy); 144 145 QHttpNetworkRequest::Operation operation; 146 QByteArray customVerb; 147 QHttpNetworkRequest::Priority priority; 148 mutable QNonContiguousByteDevice* uploadByteDevice; 149 bool autoDecompress; 150 bool pipeliningAllowed; 151 bool withCredentials; 152 bool ssl; 153 }; 154 155 156 QT_END_NAMESPACE 157 158 //Q_DECLARE_METATYPE(QHttpNetworkRequest) 159 160 #endif // QT_NO_HTTP 161 162 163 #endif // QHTTPNETWORKREQUEST_H 164