File: httpserver.h

package info (click to toggle)
qt6-webengine 6.9.2%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 4,111,640 kB
  • sloc: cpp: 21,437,331; ansic: 8,087,115; javascript: 2,747,888; python: 856,615; asm: 848,149; xml: 616,344; java: 222,847; sh: 105,209; objc: 99,183; perl: 70,870; cs: 51,103; sql: 40,087; makefile: 26,384; pascal: 25,140; fortran: 24,137; tcl: 9,609; yacc: 8,132; php: 7,051; lisp: 3,462; lex: 1,327; ruby: 914; awk: 339; csh: 120; sed: 36
file content (82 lines) | stat: -rw-r--r-- 2,522 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
#ifndef HTTPSERVER_H
#define HTTPSERVER_H

#include "httpreqrep.h"

#include <QTcpServer>
#include <QUrl>

// Listens on a TCP socket and creates HttpReqReps for each connection.
//
// Usage:
//
//     HttpServer server;
//     connect(&server, &HttpServer::newRequest, [](HttpReqRep *rr) {
//         if (rr->requestPath() == "/myPage.html") {
//             rr->setResponseBody("<html><body>Hello, World!</body></html>");
//             rr->sendResponse();
//         }
//     });
//     QVERIFY(server.start());
//     /* do stuff */
//     QVERIFY(server.stop());
//
// HttpServer owns the HttpReqRep objects. The signal handler should not store
// references to HttpReqRep objects.
//
// Only if a handler calls sendResponse() will a response be actually sent. This
// means that multiple handlers can be connected to the signal, with different
// handlers responsible for different paths.
class HttpServer : public QObject
{
    Q_OBJECT
public:
    explicit HttpServer(QObject *parent = nullptr);
    HttpServer(const QHostAddress &hostAddress, quint16 port, QObject *parent = nullptr);
    HttpServer(QTcpServer *server, const QString &protocol, const QHostAddress &address,
               quint16 port, QObject *parent = nullptr);

    ~HttpServer() override;

    // Must be called to start listening.
    //
    // Returns true if a TCP port has been successfully bound.
    Q_INVOKABLE Q_REQUIRED_RESULT bool start();

    // Stops listening and performs final error checks.
    Q_INVOKABLE Q_REQUIRED_RESULT bool stop();

    Q_INVOKABLE void setExpectError(bool b);

    // Full URL for given relative path
    Q_INVOKABLE QUrl url(const QString &path = QStringLiteral("/")) const;

    Q_INVOKABLE QString sharedDataDir() const;

    Q_INVOKABLE void setResourceDirs(const QStringList &dirs) { m_dirs = dirs; }

    Q_INVOKABLE void setHostDomain(const QString &host) { m_url.setHost(host); }

    Q_INVOKABLE QTcpServer *getTcpServer() const { return m_tcpServer; }

Q_SIGNALS:
    // Emitted after a HTTP request has been successfully parsed.
    void newRequest(HttpReqRep *reqRep);

private Q_SLOTS:
    void handleNewConnection();

private:
    QTcpServer *m_tcpServer;
    QUrl m_url;
    QStringList m_dirs;
    bool m_error = false;
    bool m_ignoreNewConnection = false;
    bool m_expectingError = false;
    QHostAddress m_hostAddress;
    quint16 m_port;
};

#endif // !HTTPSERVER_H