src/imports/qmlwebsockets/qqmlwebsocket.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2014 Kurt Pattyn <pattyn.kurt@gmail.com>.
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtWebSockets 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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLWEBSOCKET_H
  43 #define QQMLWEBSOCKET_H
  44
  45 #include <QObject>
  46 #include <QQmlParserStatus>
  47 #include <QtQml>
  48 #include <QScopedPointer>
  49 #include <QtWebSockets/QWebSocket>
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 class QQmlWebSocket : public QObject, public QQmlParserStatus
  54 {
  55     Q_OBJECT
  56     Q_DISABLE_COPY(QQmlWebSocket)
  57     Q_INTERFACES(QQmlParserStatus)
  58
  59     Q_ENUMS(Status)
  60     Q_PROPERTY(QUrl url READ url WRITE setUrl NOTIFY urlChanged)
  61     Q_PROPERTY(Status status READ status NOTIFY statusChanged)
  62     Q_PROPERTY(QString errorString READ errorString NOTIFY errorStringChanged)
  63     Q_PROPERTY(bool active READ isActive WRITE setActive NOTIFY activeChanged)
  64
  65 public:
  66     explicit QQmlWebSocket(QObject *parent = Q_NULLPTR);
  67     virtual ~QQmlWebSocket();
  68
  69     enum Status
  70     {
  71         Connecting  = 0,
  72         Open        = 1,
  73         Closing     = 2,
  74         Closed      = 3,
  75         Error       = 4
  76     };
  77
  78     QUrl url() const;
  79     void setUrl(const QUrl &url);
  80     Status status() const;
  81     QString errorString() const;
  82
  83     void setActive(bool active);
  84     bool isActive() const;
  85
  86     Q_INVOKABLE qint64 sendTextMessage(const QString &message);
  87
  88
  89 Q_SIGNALS:
  90     void textMessageReceived(QString message);
  91     void statusChanged(Status status);
  92     void activeChanged(bool isActive);
  93     void errorStringChanged(QString errorString);
  94     void urlChanged();
  95
  96 public:
  97     void classBegin() Q_DECL_OVERRIDE;
  98     void componentComplete() Q_DECL_OVERRIDE;
  99
 100 private Q_SLOTS:
 101     void onError(QAbstractSocket::SocketError error);
 102     void onStateChanged(QAbstractSocket::SocketState state);
 103
 104 private:
 105     QScopedPointer<QWebSocket> m_webSocket;
 106     Status m_status;
 107     QUrl m_url;
 108     bool m_isActive;
 109     bool m_componentCompleted;
 110     QString m_errorString;
 111
 112     void setStatus(Status status);
 113     void open();
 114     void close();
 115     void setErrorString(QString errorString = QString());
 116 };
 117
 118 QT_END_NAMESPACE
 119
 120 #endif // QQMLWEBSOCKET_H