summaryrefslogtreecommitdiffstats
path: root/src/httpserver/qhttpserverfutureresponse.cpp
blob: 2409e6a54b8af446be6e8dc30236f661d9b718ca (plain)
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/****************************************************************************
**
** Copyright (C) 2020 Mikhail Svetkin <mikhail.svetkin@gmail.com>
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtHttpServer module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) 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.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-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qhttpserverfutureresponse.h"

#include <QtCore/qfuture.h>
#include <QtCore/qfuturewatcher.h>

#include <QtNetwork/qtcpsocket.h>

#include <QtHttpServer/qhttpserverresponder.h>

#include <private/qhttpserverresponse_p.h>


QT_BEGIN_NAMESPACE

/*!
    \class QHttpServerFutureResponse
    \brief QHttpServerFutureResponse is a simplified API for asynchronous responses.

    \code

    QHttpServer server;

    server.route("/feature/", [] (int id) -> QHttpServerFutureResponse {
        auto future = QtConcurrent::run([] () {
            return QHttpServerResponse("the future is coming");
        });

        return future;
    });
    server.listen();

    \endcode
*/

#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)

QHttpServerResponse QFutureInterface<QHttpServerResponse>::takeResult()
{
    if (isCanceled()) {
        exceptionStore().throwPossibleException();
        return QHttpServerResponse::StatusCode::NotFound;
    }
    // Note: we wait for all, this is intentional,
    // not to mess with other unready results.
    waitForResult(-1);

#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
    std::lock_guard<QMutex> locker{*mutex()};
#else
    std::lock_guard<QMutex> locker{mutex(0)};
#endif
    QtPrivate::ResultIteratorBase position = resultStoreBase().resultAt(0);
    auto ret = std::move_if_noexcept(
        *const_cast<QHttpServerResponse *>(position.pointer<QHttpServerResponse>()));
    resultStoreBase().template clear<QHttpServerResponse>();

    return ret;
}

#endif // QT_VERSION < QT_VERSION_CHECK(6, 0, 0)

struct QResponseWatcher : public QFutureWatcher<QHttpServerResponse>
{
    Q_OBJECT

public:
    QResponseWatcher(QHttpServerResponder &&_responder)
        : QFutureWatcher<QHttpServerResponse>(),
          responder(std::move(_responder)) {
    }

    QHttpServerResponder responder;
};

class QHttpServerFutureResponsePrivate : public QHttpServerResponsePrivate
{
public:
    QHttpServerFutureResponsePrivate(const QFuture<QHttpServerResponse> &futureResponse)
        : QHttpServerResponsePrivate(),
          futureResp(futureResponse)
    {
    }

    QFuture<QHttpServerResponse> futureResp;
};

/*!
    Constructs a new QHttpServerFutureResponse with the \a future response.
*/
QHttpServerFutureResponse::QHttpServerFutureResponse(const QFuture<QHttpServerResponse> &futureResp)
    : QHttpServerFutureResponse(new QHttpServerFutureResponsePrivate{futureResp})
{
}

/*!
    \internal
*/
QHttpServerFutureResponse::QHttpServerFutureResponse(QHttpServerFutureResponsePrivate *d)
    : QHttpServerResponse(d)
{
}

/*!
    \reimp
*/
void QHttpServerFutureResponse::write(QHttpServerResponder &&responder) const
{
    if (!d_ptr->derived) {
        QHttpServerResponse::write(std::move(responder));
        return;
    }

    Q_D(const QHttpServerFutureResponse);

    auto socket = responder.socket();
    auto futureWatcher = new QResponseWatcher(std::move(responder));

    QObject::connect(socket, &QObject::destroyed,
                     futureWatcher, &QObject::deleteLater);
    QObject::connect(futureWatcher, &QFutureWatcherBase::finished,
                     socket,
                    [futureWatcher] () mutable {
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
        auto resp = futureWatcher->future().d.takeResult();
#else
        auto resp = futureWatcher->future().takeResult();
#endif
        resp.write(std::move(futureWatcher->responder));
        futureWatcher->deleteLater();
    });

    futureWatcher->setFuture(d->futureResp);
}

QT_END_NAMESPACE

#include "qhttpserverfutureresponse.moc"