qasyncio.h Include File

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# qasyncio.h

This is the verbatim text of the qasyncio.h include file. It is provided only for illustration; the copyright remains with Trolltech.

    /****************************************************************************
    ** $Id: qt/qasyncio.h   3.3.8   edited Jan 11 14:38 $
    **
    ** Definition of asynchronous I/O classes
    **
    ** Created : 970617
    **
    ** Copyright (C) 1992-2007 Trolltech ASA.  All rights reserved.
    **
    ** This file is part of the kernel module of the Qt GUI Toolkit.
    **
    ** This file may be used under the terms of the GNU General Public
    ** License versions 2.0 or 3.0 as published by the Free Software
    ** Foundation and appearing in the file LICENSE.GPL included in the
    ** packaging of this file. Alternatively you may (at your option) use any
    ** later version of the GNU General Public License if such license has
    ** been publicly approved by Trolltech ASA (or its successors, if any)
    ** and the KDE Free Qt Foundation.
    **
    ** Please review the following information to ensure GNU General
    ** Public Licensing requirements will be met:
    ** http://trolltech.com/products/qt/licenses/licensing/opensource/.
    ** If you are unsure which license is appropriate for your use, please
    ** review the following information:
    ** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
    ** or contact the sales department at sales@trolltech.com.
    **
    ** This file may be used under the terms of the Q Public License as
    ** defined by Trolltech ASA and appearing in the file LICENSE.QPL
    ** included in the packaging of this file.  Licensees holding valid Qt
    ** Commercial licenses may use this file in accordance with the Qt
    ** Commercial License Agreement provided with the Software.
    **
    ** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
    ** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
    ** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
    ** herein.
    **
    **********************************************************************/

    #ifndef QASYNCIO_H
    #define QASYNCIO_H

    #ifndef QT_H
    #include "qobject.h"
    #include "qsignal.h"
    #include "qtimer.h"
    #endif // QT_H

    #ifndef QT_NO_ASYNC_IO

    class QIODevice;

    class Q_EXPORT QAsyncIO {
    public:
        virtual ~QAsyncIO();
        void connect(QObject*, const char *member);

    protected:
        void ready();

    private:
        QSignal signal;
    };

    class Q_EXPORT QDataSink : public QAsyncIO {
    public:
        // Call this to know how much I can take.
        virtual int readyToReceive()=0;
        virtual void receive(const uchar*, int count)=0;
        virtual void eof()=0;
        void maybeReady();
    };

    class Q_EXPORT QDataSource : public QAsyncIO {
    public:
        virtual int readyToSend()=0; // returns -1 when never any more ready
        virtual void sendTo(QDataSink*, int count)=0;
        void maybeReady();

        virtual bool rewindable() const;
        virtual void enableRewind(bool);
        virtual void rewind();
    };

    class Q_EXPORT QIODeviceSource : public QDataSource {
        const int buf_size;
        uchar *buffer;
        QIODevice* iod;
        bool rew;

    public:
        QIODeviceSource(QIODevice*, int bufsize=4096);
       ~QIODeviceSource();

        int readyToSend();
        void sendTo(QDataSink* sink, int n);
        bool rewindable() const;
        void enableRewind(bool on);
        void rewind();
    };

    class Q_EXPORT QDataPump : public QObject {
        Q_OBJECT
        int interval;
        QTimer timer;
        QDataSource* source;
        QDataSink* sink;

    public:
        QDataPump(QDataSource*, QDataSink*);

    private slots:
        void kickStart();
        void tryToPump();
    };

    #endif	// QT_NO_ASYNC_IO

    #endif