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: |
Public Functions
QWebChannelAbstractTransport(QObject * parent = 0) | |
virtual | ~QWebChannelAbstractTransport() |
Public Slots
virtual void | sendMessage(const QJsonObject & message) = 0 |
Signals
void | messageReceived(const QJsonObject & message, QWebChannelAbstractTransport * transport) |
Detailed Description
Communication channel between the C++ QWebChannel server and a HTML/JS client.
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}{Standalone Example} shows how this can be done using Qt WebSockets. Qt WebKit implements this interface internally and uses the native WebKit IPC mechanism to transmit messages to HTML clients.
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 = 0)
Constructs a transport object with the given parent.
[virtual]
QWebChannelAbstractTransport::~QWebChannelAbstractTransport()
Destroys the transport object.
[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)
Send a JSON message to the remote client. An implementation would serialize the message and transmit it to the remote JavaScript client.