summaryrefslogtreecommitdiffstats
path: root/framework/src/fabric.h
blob: 9a060cb960d4a0349f93438390ca4eebbf35f998 (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
/*
    Copyright (c) 2016 Christian Mollekopf <mollekopf@kolabsys.com>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/
#pragma once

#include "kube_export.h"
#include <QObject>
#include <QVariant>
#include <QVector>

namespace Kube {
/**
 * The Fabric is a publish/subscribe message bus to interconnect components in kube.
 *
 * It provides a background mesh ("the fabric"), that interconnects various parts of kube.
 * This is useful as it allows us to decouple functionality from the UI components, and keeps us from writing unnecessary API
 * for visual components to pass through all necessary information for interaction.
 */
namespace Fabric {

class KUBE_EXPORT Fabric : public QObject {
    Q_OBJECT
public:
    Q_INVOKABLE void postMessage(const QString &id, const QVariantMap &);
};

/**
 * A message handler.
 *
 * Can beinstantiated from QML like so:
 * Listener {
 *   function onMessageReceived(msg) {
 *      ...do something
 *   }
 * }
 */
class KUBE_EXPORT Listener : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString filter MEMBER mFilter)

public:
    Listener(QObject *parent = 0);
    virtual ~Listener();

    virtual void notify(const QString &id, const QVariantMap &notification);

signals:
    void messageReceived(const QVariantMap &message);

private:
    QString mFilter;
};

}
}