tests/auto/qml/debugger/shared/qqmldebugclient.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLDEBUGCLIENT_H
  43 #define QQMLDEBUGCLIENT_H
  44
  45 #include <QtNetwork/qtcpsocket.h>
  46
  47 #include <private/qtqmlglobal_p.h>
  48
  49 class QQmlDebugConnectionPrivate;
  50 class Q_QML_PRIVATE_EXPORT QQmlDebugConnection : public QIODevice
  51 {
  52     Q_OBJECT
  53     Q_DISABLE_COPY(QQmlDebugConnection)
  54 public:
  55     QQmlDebugConnection(QObject * = 0);
  56     ~QQmlDebugConnection();
  57
  58     void connectToHost(const QString &hostName, quint16 port);
  59
  60     qint64 bytesAvailable() const;
  61     bool isConnected() const;
  62     QAbstractSocket::SocketState state() const;
  63     void flush();
  64     bool isSequential() const;
  65     void close();
  66     bool waitForConnected(int msecs = 30000);
  67
  68 signals:
  69     void connected();
  70     void stateChanged(QAbstractSocket::SocketState socketState);
  71     void error(QAbstractSocket::SocketError socketError);
  72
  73 protected:
  74     qint64 readData(char *data, qint64 maxSize);
  75     qint64 writeData(const char *data, qint64 maxSize);
  76
  77 private:
  78     QQmlDebugConnectionPrivate *d;
  79     friend class QQmlDebugClient;
  80     friend class QQmlDebugClientPrivate;
  81 };
  82
  83 class QQmlDebugClientPrivate;
  84 class Q_QML_PRIVATE_EXPORT QQmlDebugClient : public QObject
  85 {
  86     Q_OBJECT
  87     Q_DECLARE_PRIVATE(QQmlDebugClient)
  88     Q_DISABLE_COPY(QQmlDebugClient)
  89
  90 public:
  91     enum State { NotConnected, Unavailable, Enabled };
  92
  93     QQmlDebugClient(const QString &, QQmlDebugConnection *parent);
  94     ~QQmlDebugClient();
  95
  96     QString name() const;
  97     float serviceVersion() const;
  98     State state() const;
  99
 100     virtual void sendMessage(const QByteArray &);
 101
 102 protected:
 103     virtual void stateChanged(State);
 104     virtual void messageReceived(const QByteArray &);
 105
 106 private:
 107     QQmlDebugClientPrivate *d;
 108     friend class QQmlDebugConnection;
 109     friend class QQmlDebugConnectionPrivate;
 110 };
 111
 112 #endif // QQMLDEBUGCLIENT_H