src/declarative/debugger/qpacketprotocol_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 QPACKETPROTOCOL_H
  43 #define QPACKETPROTOCOL_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 <QtCore/qobject.h>
  57 #include <QtCore/qdatastream.h>
  58
  59 #include <private/qdeclarativeglobal_p.h>
  60
  61 QT_BEGIN_HEADER
  62
  63 QT_BEGIN_NAMESPACE
  64
  65
  66 class QIODevice;
  67 class QBuffer;
  68 class QPacket;
  69 class QPacketAutoSend;
  70 class QPacketProtocolPrivate;
  71
  72 class Q_DECLARATIVE_PRIVATE_EXPORT QPacketProtocol : public QObject
  73 {
  74     Q_OBJECT
  75 public:
  76     explicit QPacketProtocol(QIODevice *dev, QObject *parent = 0);
  77     virtual ~QPacketProtocol();
  78
  79     qint32 maximumPacketSize() const;
  80     qint32 setMaximumPacketSize(qint32);
  81
  82     QPacketAutoSend send();
  83     void send(const QPacket &);
  84
  85     qint64 packetsAvailable() const;
  86     QPacket read();
  87
  88     bool waitForReadyRead(int msecs = 3000);
  89
  90     void clear();
  91
  92     QIODevice *device();
  93
  94 Q_SIGNALS:
  95     void readyRead();
  96     void invalidPacket();
  97     void packetWritten();
  98
  99 private:
 100     QPacketProtocolPrivate *d;
 101 };
 102
 103
 104 class Q_DECLARATIVE_PRIVATE_EXPORT QPacket : public QDataStream
 105 {
 106 public:
 107     QPacket();
 108     QPacket(const QPacket &);
 109     virtual ~QPacket();
 110
 111     void clear();
 112     bool isEmpty() const;
 113     QByteArray data() const;
 114
 115 protected:
 116     friend class QPacketProtocol;
 117     QPacket(const QByteArray &ba);
 118     QByteArray b;
 119     QBuffer *buf;
 120 };
 121
 122 class Q_DECLARATIVE_PRIVATE_EXPORT QPacketAutoSend : public QPacket
 123 {
 124 public:
 125     virtual ~QPacketAutoSend();
 126
 127 private:
 128     friend class QPacketProtocol;
 129     QPacketAutoSend(QPacketProtocol *);
 130     QPacketProtocol *p;
 131 };
 132
 133 QT_END_NAMESPACE
 134
 135 QT_END_HEADER
 136
 137 #endif