aboutsummaryrefslogtreecommitdiff
path: root/src/base/QXmppPromise.h
blob: 6408ad0c3279f1ea0362d5a029d57fcef3e7148f (plain) (blame)
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
// SPDX-FileCopyrightText: 2022 Linus Jahn <lnj@kaidan.im>
// SPDX-FileCopyrightText: 2022 Jonah Brüchert <jbb@kaidan.im>
//
// SPDX-License-Identifier: LGPL-2.1-or-later

#ifndef QXMPPPROMISE_H
#define QXMPPPROMISE_H

#include "QXmppTask.h"

///
/// \brief Create and update QXmppTask objects to communicate results of asynchronous operations.
///
/// Unlike QFuture, this is not thread-safe. This avoids the need to do mutex locking at every
/// access though.
///
/// \ingroup Core classes
///
/// \since QXmpp 1.5
///
template<typename T>
class QXmppPromise
{
    static_assert(!std::is_abstract_v<T>);

public:
    template<typename U = T, std::enable_if_t<std::is_void_v<U>> * = nullptr>
    QXmppPromise()
        : d(QXmpp::Private::TaskPrivate(nullptr))
    {
    }

    template<typename U = T, std::enable_if_t<!std::is_void_v<U>> * = nullptr>
    QXmppPromise()
        : d(QXmpp::Private::TaskPrivate([](void *r) { delete static_cast<T *>(r); }))
    {
    }

    ///
    /// Report that the asynchronous operation has finished, and call the connected handler of the
    /// QXmppTask<T> belonging to this promise.
    ///
    /// \param value The result of the asynchronous computation
    ///
#ifdef QXMPP_DOC
    void reportFinished(T &&value)
#else
    template<typename U, typename TT = T, std::enable_if_t<!std::is_void_v<TT> && std::is_same_v<TT, U>> * = nullptr>
    void finish(U &&value)
#endif
    {
        Q_ASSERT(!d.isFinished());
        d.setFinished(true);
        if (d.continuation()) {
            if (d.isContextAlive()) {
                d.invokeContinuation(&value);
            }
        } else {
            d.setResult(new U(std::move(value)));
        }
    }

    /// \cond
    template<typename U, typename TT = T, std::enable_if_t<!std::is_void_v<TT> && std::is_constructible_v<TT, U> && !std::is_same_v<TT, U>> * = nullptr>
    void finish(U &&value)
    {
        Q_ASSERT(!d.isFinished());
        d.setFinished(true);
        if (d.continuation()) {
            if (d.isContextAlive()) {
                T convertedValue { std::move(value) };
                d.invokeContinuation(&convertedValue);
            }
        } else {
            d.setResult(new T(std::move(value)));
        }
    }

    template<typename U = T, std::enable_if_t<std::is_void_v<U>> * = nullptr>
    void finish()
    {
        Q_ASSERT(!d.isFinished());
        d.setFinished(true);
        if (d.continuation()) {
            if (d.isContextAlive()) {
                d.invokeContinuation(nullptr);
            }
        }
    }
    /// \endcond

    ///
    /// Obtain a handle to this promise that allows to obtain the value that will be produced
    /// asynchronously.
    ///
    QXmppTask<T> task()
    {
        return QXmppTask<T>(d);
    }

private:
    QXmpp::Private::TaskPrivate d;
};

#endif  // QXMPPPROMISE_H