src/declarative/debugger/qdeclarativedebugclient_p.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 QtDeclarative 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 QDECLARATIVEDEBUGCLIENT_H
  43 #define QDECLARATIVEDEBUGCLIENT_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtNetwork/qtcpsocket.h>
  57
  58 #include <private/qdeclarativeglobal_p.h>
  59
  60 QT_BEGIN_HEADER
  61
  62 QT_BEGIN_NAMESPACE
  63
  64
  65 class QDeclarativeDebugConnectionPrivate;
  66 class Q_DECLARATIVE_PRIVATE_EXPORT QDeclarativeDebugConnection : public QIODevice
  67 {
  68     Q_OBJECT
  69     Q_DISABLE_COPY(QDeclarativeDebugConnection)
  70 public:
  71     QDeclarativeDebugConnection(QObject * = 0);
  72     ~QDeclarativeDebugConnection();
  73
  74     void connectToHost(const QString &hostName, quint16 port);
  75
  76     qint64 bytesAvailable() const;
  77     bool isConnected() const;
  78     QAbstractSocket::SocketState state() const;
  79     void flush();
  80     bool isSequential() const;
  81     void close();
  82     bool waitForConnected(int msecs = 30000);
  83
  84 signals:
  85     void connected();
  86     void stateChanged(QAbstractSocket::SocketState socketState);
  87     void error(QAbstractSocket::SocketError socketError);
  88
  89 protected:
  90     qint64 readData(char *data, qint64 maxSize);
  91     qint64 writeData(const char *data, qint64 maxSize);
  92
  93 private:
  94     QDeclarativeDebugConnectionPrivate *d;
  95     friend class QDeclarativeDebugClient;
  96     friend class QDeclarativeDebugClientPrivate;
  97 };
  98
  99 class QDeclarativeDebugClientPrivate;
 100 class Q_DECLARATIVE_PRIVATE_EXPORT QDeclarativeDebugClient : public QObject
 101 {
 102     Q_OBJECT
 103     Q_DECLARE_PRIVATE(QDeclarativeDebugClient)
 104     Q_DISABLE_COPY(QDeclarativeDebugClient)
 105
 106 public:
 107     enum Status { NotConnected, Unavailable, Enabled };
 108
 109     QDeclarativeDebugClient(const QString &, QDeclarativeDebugConnection *parent);
 110     ~QDeclarativeDebugClient();
 111
 112     QString name() const;
 113     float serviceVersion() const;
 114     Status status() const;
 115
 116     virtual void sendMessage(const QByteArray &);
 117
 118 protected:
 119     virtual void statusChanged(Status);
 120     virtual void messageReceived(const QByteArray &);
 121
 122 private:
 123     friend class QDeclarativeDebugConnection;
 124     friend class QDeclarativeDebugConnectionPrivate;
 125 };
 126
 127 QT_END_NAMESPACE
 128
 129 QT_END_HEADER
 130
 131 #endif // QDECLARATIVEDEBUGCLIENT_H