aboutsummaryrefslogtreecommitdiff
path: root/src/client/QXmppRpcManager.h
blob: fca992ee54c7d4b5579ac39920945f6822511e74 (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
// SPDX-FileCopyrightText: 2010 Jeremy Lainé <jeremy.laine@m4x.org>
//
// SPDX-License-Identifier: LGPL-2.1-or-later

#ifndef QXMPPRPCMANAGER_H
#define QXMPPRPCMANAGER_H

#include "QXmppClientExtension.h"
#include "QXmppInvokable.h"
#include "QXmppRemoteMethod.h"

#include <QMap>
#include <QVariant>

class QXmppRpcErrorIq;
class QXmppRpcInvokeIq;
class QXmppRpcResponseIq;

/// \brief The QXmppRpcManager class make it possible to invoke remote methods
/// and to expose local interfaces for remote procedure calls, as specified by
/// \xep{0009}: Jabber-RPC.
///
/// To make use of this manager, you need to instantiate it and load it into
/// the QXmppClient instance as follows:
///
/// \code
/// QXmppRpcManager *manager = new QXmppRpcManager;
/// client->addExtension(manager);
/// \endcode
///
/// \note THIS API IS NOT FINALIZED YET
///
/// \ingroup Managers

class QXMPP_EXPORT QXmppRpcManager : public QXmppClientExtension
{
    Q_OBJECT

public:
    QXmppRpcManager();

    void addInvokableInterface(QXmppInvokable *interface);
    QXmppRemoteMethodResult callRemoteMethod(const QString &jid,
                                             const QString &interface,
                                             const QVariant &arg1 = QVariant(),
                                             const QVariant &arg2 = QVariant(),
                                             const QVariant &arg3 = QVariant(),
                                             const QVariant &arg4 = QVariant(),
                                             const QVariant &arg5 = QVariant(),
                                             const QVariant &arg6 = QVariant(),
                                             const QVariant &arg7 = QVariant(),
                                             const QVariant &arg8 = QVariant(),
                                             const QVariant &arg9 = QVariant(),
                                             const QVariant &arg10 = QVariant());

    /// \cond
    QStringList discoveryFeatures() const override;
    QList<QXmppDiscoveryIq::Identity> discoveryIdentities() const override;
    bool handleStanza(const QDomElement &element) override;
    /// \endcond

Q_SIGNALS:
    /// \cond
    void rpcCallResponse(const QXmppRpcResponseIq &result);
    void rpcCallError(const QXmppRpcErrorIq &err);
    /// \endcond

private:
    void invokeInterfaceMethod(const QXmppRpcInvokeIq &iq);

    QMap<QString, QXmppInvokable *> m_interfaces;
};

#endif