summaryrefslogtreecommitdiff
path: root/src/webchannel/qwebchanneltransportinterface.h
blob: 9044c6825abbd7e26f3cf6366805a5ac37e03180 (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
/****************************************************************************
**
** Copyright (C) 2014 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtWebChannel module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QWEBCHANNELTRANSPORTINTERFACE_H
#define QWEBCHANNELTRANSPORTINTERFACE_H

#include <QObject>

#include <QtWebChannel/qwebchannelglobal.h>

QT_BEGIN_NAMESPACE

class Q_WEBCHANNEL_EXPORT QWebChannelMessageHandlerInterface
{
public:
    virtual ~QWebChannelMessageHandlerInterface() {}

    /**
     * Handle a text message from a web channel client.
     */
    virtual void handleMessage(const QString &message) = 0;
};

#define QWebChannelMessageHandlerInterface_iid "org.qt-project.Qt.QWebChannelMessageHandlerInterface"
Q_DECLARE_INTERFACE(QWebChannelMessageHandlerInterface, QWebChannelMessageHandlerInterface_iid);
Q_DECLARE_METATYPE(QWebChannelMessageHandlerInterface*)

class Q_WEBCHANNEL_EXPORT QWebChannelTransportInterface
{
public:
    virtual ~QWebChannelTransportInterface() {}

    /**
     * Send a text message to all web channel clients.
     */
    virtual void sendMessage(const QString &message) const = 0;

    /**
     * Send a binary message to all web channel clients.
     */
    virtual void sendMessage(const QByteArray &message) const = 0;

    /**
     * Sets the message handler that will be called on incoming messages from web channel clients.
     */
    virtual void setMessageHandler(QWebChannelMessageHandlerInterface *handler) = 0;
};

#define QWebChannelTransportInterface_iid "org.qt-project.Qt.QWebChannelTransportInterface"
Q_DECLARE_INTERFACE(QWebChannelTransportInterface, QWebChannelTransportInterface_iid);
Q_DECLARE_METATYPE(QWebChannelTransportInterface*)

QT_END_NAMESPACE

#endif // QWEBCHANNELTRANSPORTINTERFACE_H