summaryrefslogtreecommitdiffstats
path: root/src/httpserver/qhttpserverrequest.h
diff options
context:
space:
mode:
authorJesus Fernandez <jesus.fernandez@qt.io>2018-03-08 18:45:53 +0100
committerJesus Fernandez <Jesus.Fernandez@qt.io>2018-07-16 14:36:08 +0000
commitb24745265dea23f7ca2d331e4432c082d1c2bc75 (patch)
tree6f5f755d6fa16145fee026c2c392adbdc7ca97b9 /src/httpserver/qhttpserverrequest.h
parent050abe1f33b4bb7646621cc4c98abb7cf5f13922 (diff)
Introduce Qt HttpServer framework
Small, Qt integrated framework for creating specialized http server. Goals of the project: - Create a framework allowing creation of a specialized web server running in non public networks (home and company networks, stealth or hidden services) - Create an easy tool for developers to embed http servers in their apps. - Playground to narrow down problems in Qt, related to network stack, but also to explore general usability. - Potentially reduce code duplication in Qt. Not goals: - Standalone server, in particular not Apache or nginx replacement Change-Id: I0d8b83e50992b9a95c88f4735539329279cf5425 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Diffstat (limited to 'src/httpserver/qhttpserverrequest.h')
-rw-r--r--src/httpserver/qhttpserverrequest.h101
1 files changed, 101 insertions, 0 deletions
diff --git a/src/httpserver/qhttpserverrequest.h b/src/httpserver/qhttpserverrequest.h
new file mode 100644
index 0000000..0e9a893
--- /dev/null
+++ b/src/httpserver/qhttpserverrequest.h
@@ -0,0 +1,101 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtHttpServer module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QHTTPSERVERREQUEST_H
+#define QHTTPSERVERREQUEST_H
+
+#include <QtHttpServer/qthttpserverglobal.h>
+
+#include <QtCore/qdebug.h>
+#include <QtCore/qglobal.h>
+#include <QtCore/qshareddata.h>
+#include <QtCore/qurl.h>
+
+QT_BEGIN_NAMESPACE
+
+class QRegularExpression;
+class QString;
+class QTcpSocket;
+
+class QHttpServerRequestPrivate;
+class Q_HTTPSERVER_EXPORT QHttpServerRequest : public QObjectUserData
+{
+ friend class QAbstractHttpServerPrivate;
+ friend class QHttpServerResponse;
+
+public:
+ ~QHttpServerRequest() override;
+
+ enum class Method
+ {
+ Unknown = -1,
+
+ Get,
+ Put,
+ Delete,
+ Post,
+ Head,
+ Options,
+ Patch
+ };
+
+ QString value(const QString &key) const;
+ QUrl url() const;
+ Method method() const;
+ QVariantMap headers() const;
+ QByteArray body() const;
+
+protected:
+ QHttpServerRequest(const QHttpServerRequest &other);
+
+private:
+#if !defined(QT_NO_DEBUG_STREAM)
+ friend QDebug operator<<(QDebug debug, const QHttpServerRequest &request);
+#endif
+
+ QHttpServerRequest();
+
+ QExplicitlySharedDataPointer<QHttpServerRequestPrivate> d;
+};
+
+QT_END_NAMESPACE
+
+Q_DECLARE_METATYPE(QHttpServerRequest::Method)
+
+#endif // QHTTPSERVERREQUEST_H