-
Richard Moe Gustavsen authored
Change-Id: I38c08520c37d84570c3c8df9d2416131defc5b40 Reviewed-by:Kurt Pattyn <pattyn.kurt@gmail.com>
f5482589
qqmlwebsocket.cpp 7.37 KiB
/******************************************************************************** Copyright (C) 2014 Kurt Pattyn <pattyn.kurt@gmail.com>.** Contact: http://www.qt-project.org/legal**** This file is part of the QtWebSockets 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$******************************************************************************//*! \qmltype WebSocket \instantiates QQmlWebSocket \inqmlmodule Qt.WebSockets \ingroup websockets-qml \brief QML interface to QWebSocket. WebSockets is a web technology providing full-duplex communications channels over a single TCP connection. The WebSocket protocol was standardized by the IETF as \l {http://tools.ietf.org/html/rfc6455} {RFC 6455} in 2011.*//*! \qmlproperty QUrl WebSocket::url Server url to connect to. The url must have one of 2 schemes: \e ws:// or \e wss://. When not supplied, then \e ws:// is used. *//*! \qmlproperty Status WebSocket::status Status of the WebSocket. The status can have the following values: \list \li WebSockets.Connecting \li WebSockets.Open \li WebSockets.Closing7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
\li WebSockets.Closed
\li WebSockets.Error
\endlist
*/
/*!
\qmlproperty QString WebSocket::errorString
Contains a description of the last error that occurred. When no error occurrred,
this string is empty.
*/
/*!
\qmlproperty bool WebSocket::active
When set to true, a connection is made to the server with the given url.
When set to false, the connection is closed.
The default value is false.
*/
/*!
\qmlsignal WebSocket::textMessageReceived(QString message)
This signal is emitted when a text message is received.
*/
/*!
\qmlsignal WebSocket::statusChanged(Status status)
This signal is emitted when the status of the WebSocket changes.
the \l {WebSocket::status}{status} argument provides the current status.
\sa WebSocket::status
*/
/*!
\qmlmethod void WebSocket::sendTextMessage(string message)
Sends \c message to the server.
*/
#include "qqmlwebsocket.h"
#include <QtWebSockets/QWebSocket>
QT_BEGIN_NAMESPACE
QQmlWebSocket::QQmlWebSocket(QObject *parent) :
QObject(parent),
m_webSocket(),
m_status(Closed),
m_url(),
m_isActive(false),
m_componentCompleted(true),
m_errorString()
{
}
QQmlWebSocket::~QQmlWebSocket()
{
}
qint64 QQmlWebSocket::sendTextMessage(const QString &message)
{
if (m_status != Open) {
setErrorString(tr("Messages can only be sent when the socket is open."));
setStatus(Error);
return 0;
}
return m_webSocket->sendTextMessage(message);
}
QUrl QQmlWebSocket::url() const
{
return m_url;
}
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
void QQmlWebSocket::setUrl(const QUrl &url)
{
if (m_url == url) {
return;
}
if (m_webSocket && (m_status == Open)) {
m_webSocket->close();
}
m_url = url;
Q_EMIT urlChanged();
if (m_webSocket) {
m_webSocket->open(m_url);
}
}
QQmlWebSocket::Status QQmlWebSocket::status() const
{
return m_status;
}
QString QQmlWebSocket::errorString() const
{
return m_errorString;
}
void QQmlWebSocket::classBegin()
{
m_componentCompleted = false;
m_errorString = tr("QQmlWebSocket is not ready.");
m_status = Closed;
}
void QQmlWebSocket::componentComplete()
{
m_webSocket.reset(new (std::nothrow) QWebSocket());
if (Q_LIKELY(m_webSocket)) {
connect(m_webSocket.data(), &QWebSocket::textMessageReceived,
this, &QQmlWebSocket::textMessageReceived);
typedef void (QWebSocket::* ErrorSignal)(QAbstractSocket::SocketError);
connect(m_webSocket.data(), static_cast<ErrorSignal>(&QWebSocket::error),
this, &QQmlWebSocket::onError);
connect(m_webSocket.data(), &QWebSocket::stateChanged,
this, &QQmlWebSocket::onStateChanged);
m_componentCompleted = true;
open();
}
}
void QQmlWebSocket::onError(QAbstractSocket::SocketError error)
{
Q_UNUSED(error)
setErrorString(m_webSocket->errorString());
setStatus(Error);
}
void QQmlWebSocket::onStateChanged(QAbstractSocket::SocketState state)
{
switch (state)
{
case QAbstractSocket::ConnectingState:
case QAbstractSocket::BoundState:
case QAbstractSocket::HostLookupState:
{
setStatus(Connecting);
break;
}
case QAbstractSocket::UnconnectedState:
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
{
setStatus(Closed);
break;
}
case QAbstractSocket::ConnectedState:
{
setStatus(Open);
break;
}
case QAbstractSocket::ClosingState:
{
setStatus(Closing);
break;
}
default:
{
setStatus(Connecting);
break;
}
}
}
void QQmlWebSocket::setStatus(QQmlWebSocket::Status status)
{
if (m_status == status) {
return;
}
m_status = status;
if (status != Error) {
setErrorString();
}
Q_EMIT statusChanged(m_status);
}
void QQmlWebSocket::setActive(bool active)
{
if (m_isActive == active) {
return;
}
m_isActive = active;
Q_EMIT activeChanged(m_isActive);
if (!m_componentCompleted) {
return;
}
if (m_isActive) {
open();
} else {
close();
}
}
bool QQmlWebSocket::isActive() const
{
return m_isActive;
}
void QQmlWebSocket::open()
{
if (m_componentCompleted && m_isActive && m_url.isValid() && Q_LIKELY(m_webSocket)) {
m_webSocket->open(m_url);
}
}
void QQmlWebSocket::close()
{
if (m_componentCompleted && Q_LIKELY(m_webSocket)) {
m_webSocket->close();
}
}
281282283284285286287288289290291
void QQmlWebSocket::setErrorString(QString errorString)
{
if (m_errorString == errorString) {
return;
}
m_errorString = errorString;
Q_EMIT errorStringChanged(m_errorString);
}
QT_END_NAMESPACE