src/network/access/qhttpnetworkrequest_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtNetwork module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  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 #include <qmetatype.h>
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 class QNonContiguousByteDevice;
  63
  64 class QHttpNetworkRequestPrivate;
  65 class Q_AUTOTEST_EXPORT QHttpNetworkRequest: public QHttpNetworkHeader
  66 {
  67 public:
  68     enum Operation {
  69         Options,
  70         Get,
  71         Head,
  72         Post,
  73         Put,
  74         Delete,
  75         Trace,
  76         Connect,
  77         Custom
  78     };
  79
  80     enum Priority {
  81         HighPriority,
  82         NormalPriority,
  83         LowPriority
  84     };
  85
  86     QHttpNetworkRequest(const QUrl &url = QUrl(), Operation operation = Get, Priority priority = NormalPriority);
  87     QHttpNetworkRequest(const QHttpNetworkRequest &other);
  88     virtual ~QHttpNetworkRequest();
  89     QHttpNetworkRequest &operator=(const QHttpNetworkRequest &other);
  90     bool operator==(const QHttpNetworkRequest &other) const;
  91
  92     QUrl url() const;
  93     void setUrl(const QUrl &url);
  94
  95     int majorVersion() const;
  96     int minorVersion() const;
  97
  98     qint64 contentLength() const;
  99     void setContentLength(qint64 length);
 100
 101     QList<QPair<QByteArray, QByteArray> > header() const;
 102     QByteArray headerField(const QByteArray &name, const QByteArray &defaultValue = QByteArray()) const;
 103     void setHeaderField(const QByteArray &name, const QByteArray &data);
 104
 105     Operation operation() const;
 106     void setOperation(Operation operation);
 107
 108     QByteArray customVerb() const;
 109     void setCustomVerb(const QByteArray &customOperation);
 110
 111     Priority priority() const;
 112     void setPriority(Priority priority);
 113
 114     bool isPipeliningAllowed() const;
 115     void setPipeliningAllowed(bool b);
 116
 117     bool withCredentials() const;
 118     void setWithCredentials(bool b);
 119
 120     bool isSsl() const;
 121     void setSsl(bool);
 122
 123     void setUploadByteDevice(QNonContiguousByteDevice *bd);
 124     QNonContiguousByteDevice* uploadByteDevice() const;
 125
 126 private:
 127     QSharedDataPointer<QHttpNetworkRequestPrivate> d;
 128     friend class QHttpNetworkRequestPrivate;
 129     friend class QHttpNetworkConnectionPrivate;
 130     friend class QHttpNetworkConnectionChannel;
 131 };
 132
 133 class QHttpNetworkRequestPrivate : public QHttpNetworkHeaderPrivate
 134 {
 135 public:
 136     QHttpNetworkRequestPrivate(QHttpNetworkRequest::Operation op,
 137         QHttpNetworkRequest::Priority pri, const QUrl &newUrl = QUrl());
 138     QHttpNetworkRequestPrivate(const QHttpNetworkRequestPrivate &other);
 139     ~QHttpNetworkRequestPrivate();
 140     bool operator==(const QHttpNetworkRequestPrivate &other) const;
 141     QByteArray methodName() const;
 142     QByteArray uri(bool throughProxy) const;
 143
 144     static QByteArray header(const QHttpNetworkRequest &request, bool throughProxy);
 145
 146     QHttpNetworkRequest::Operation operation;
 147     QByteArray customVerb;
 148     QHttpNetworkRequest::Priority priority;
 149     mutable QNonContiguousByteDevice* uploadByteDevice;
 150     bool autoDecompress;
 151     bool pipeliningAllowed;
 152     bool withCredentials;
 153     bool ssl;
 154 };
 155
 156
 157 QT_END_NAMESPACE
 158
 159 Q_DECLARE_METATYPE(QHttpNetworkRequest)
 160
 161 #endif // QT_NO_HTTP
 162
 163
 164 #endif // QHTTPNETWORKREQUEST_H