src/declarative/debugger/qdeclarativedebugclient_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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 QT_MODULE(Declarative)
  65
  66 class QDeclarativeDebugConnectionPrivate;
  67 class Q_DECLARATIVE_PRIVATE_EXPORT QDeclarativeDebugConnection : public QIODevice
  68 {
  69     Q_OBJECT
  70     Q_DISABLE_COPY(QDeclarativeDebugConnection)
  71 public:
  72     QDeclarativeDebugConnection(QObject * = 0);
  73     ~QDeclarativeDebugConnection();
  74
  75     void connectToHost(const QString &hostName, quint16 port);
  76
  77     qint64 bytesAvailable() const;
  78     bool isConnected() const;
  79     QAbstractSocket::SocketState state() const;
  80     void flush();
  81     bool isSequential() const;
  82     void close();
  83     bool waitForConnected(int msecs = 30000);
  84
  85 signals:
  86     void connected();
  87     void stateChanged(QAbstractSocket::SocketState socketState);
  88     void error(QAbstractSocket::SocketError socketError);
  89
  90 protected:
  91     qint64 readData(char *data, qint64 maxSize);
  92     qint64 writeData(const char *data, qint64 maxSize);
  93
  94 private:
  95     QDeclarativeDebugConnectionPrivate *d;
  96     friend class QDeclarativeDebugClient;
  97     friend class QDeclarativeDebugClientPrivate;
  98 };
  99
 100 class QDeclarativeDebugClientPrivate;
 101 class Q_DECLARATIVE_PRIVATE_EXPORT QDeclarativeDebugClient : public QObject
 102 {
 103     Q_OBJECT
 104     Q_DECLARE_PRIVATE(QDeclarativeDebugClient)
 105     Q_DISABLE_COPY(QDeclarativeDebugClient)
 106
 107 public:
 108     enum Status { NotConnected, Unavailable, Enabled };
 109
 110     QDeclarativeDebugClient(const QString &, QDeclarativeDebugConnection *parent);
 111     ~QDeclarativeDebugClient();
 112
 113     QString name() const;
 114
 115     Status status() const;
 116
 117     virtual void sendMessage(const QByteArray &);
 118
 119 protected:
 120     virtual void statusChanged(Status);
 121     virtual void messageReceived(const QByteArray &);
 122
 123 private:
 124     friend class QDeclarativeDebugConnection;
 125     friend class QDeclarativeDebugConnectionPrivate;
 126 };
 127
 128 QT_END_NAMESPACE
 129
 130 QT_END_HEADER
 131
 132 #endif // QDECLARATIVEDEBUGCLIENT_H