1/****************************************************************************
2**
3** Copyright (C) 2016 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.com>
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtWebChannel module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include "qwebchannelabstracttransport.h"
41
42QT_BEGIN_NAMESPACE
43
44/*!
45 \class QWebChannelAbstractTransport
46
47 \inmodule QtWebChannel
48 \brief Communication channel between the C++ QWebChannel server and a HTML/JS client.
49 \since 5.4
50
51 Users of the QWebChannel must implement this interface and connect instances of it
52 to the QWebChannel server for every client that should be connected to the QWebChannel.
53 The \l{Qt WebChannel Standalone Example} shows how this can be done
54 using \l{Qt WebSockets}.
55
56 \note The JSON message protocol is considered internal and might change over time.
57
58 \sa {Qt WebChannel Standalone Example}
59*/
60
61/*!
62 \fn QWebChannelAbstractTransport::messageReceived(const QJsonObject &message, QWebChannelAbstractTransport *transport)
63
64 This signal must be emitted when a new JSON \a message was received from the remote client. The
65 \a transport argument should be set to this transport object.
66*/
67
68/*!
69 \fn QWebChannelAbstractTransport::sendMessage(const QJsonObject &message)
70
71 Sends a JSON \a message to the remote client. An implementation would serialize the message and
72 transmit it to the remote JavaScript client.
73*/
74
75/*!
76 Constructs a transport object with the given \a parent.
77*/
78QWebChannelAbstractTransport::QWebChannelAbstractTransport(QObject *parent)
79: QObject(parent)
80{
81
82}
83
84/*!
85 Destroys the transport object.
86*/
87QWebChannelAbstractTransport::~QWebChannelAbstractTransport()
88{
89
90}
91
92QT_END_NAMESPACE
93

source code of qtwebchannel/src/webchannel/qwebchannelabstracttransport.cpp