QWebChannelAbstractTransport Class

Communication channel between the C++ QWebChannel server and a HTML/JS client. More...

Header:	#include <QWebChannelAbstractTransport>
qmake:	QT += webchannel
Since:	Qt 5.4
Inherits:	QObject

This class was introduced in Qt 5.4.

• List of all members, including inherited members

Public Functions

	QWebChannelAbstractTransport(QObject *parent = Q_NULLPTR)
virtual	~QWebChannelAbstractTransport()

Public Slots

virtual void

sendMessage(const QJsonObject &message) = 0

Signals

void	messageReceived(const QJsonObject &message, QWebChannelAbstractTransport *transport)

Detailed Description

Users of the QWebChannel must implement this interface and connect instances of it to the QWebChannel server for every client that should be connected to the QWebChannel. The Qt WebChannel Standalone Example shows how this can be done using Qt WebSockets.

Note: The JSON message protocol is considered internal and might change over time.

See also Qt WebChannel Standalone Example.

Member Function Documentation

QWebChannelAbstractTransport::QWebChannelAbstractTransport(QObject *parent = Q_NULLPTR)

Constructs a transport object with the given parent.

[signal] void QWebChannelAbstractTransport::messageReceived(const QJsonObject &message, QWebChannelAbstractTransport *transport)

This signal must be emitted when a new JSON message was received from the remote client. The transport argument should be set to this transport object.

[pure virtual slot] void QWebChannelAbstractTransport::sendMessage(const QJsonObject &message)

Sends a JSON message to the remote client. An implementation would serialize the message and transmit it to the remote JavaScript client.

[virtual] QWebChannelAbstractTransport::~QWebChannelAbstractTransport()

Destroys the transport object.