QuaZIP quazip-0-7-3
Public Member Functions | Protected Member Functions
QuaZIODevice Class Reference

A class to compress/decompress QIODevice. More...

#include <quaziodevice.h>

List of all members.

Public Member Functions

 QuaZIODevice (QIODevice *io, QObject *parent=NULL)
 ~QuaZIODevice ()
virtual bool flush ()
 Flushes data waiting to be written.
virtual bool open (QIODevice::OpenMode mode)
 Opens the device.
virtual void close ()
 Closes this device, but not the underlying one.
QIODevice * getIoDevice () const
 Returns the underlying device.
virtual bool isSequential () const
 Returns true.
virtual bool atEnd () const
 Returns true iff the end of the compressed stream is reached.
virtual qint64 bytesAvailable () const
 Returns the number of the bytes buffered.

Protected Member Functions

virtual qint64 readData (char *data, qint64 maxSize)
 Implementation of QIODevice::readData().
virtual qint64 writeData (const char *data, qint64 maxSize)
 Implementation of QIODevice::writeData().

Detailed Description

A class to compress/decompress QIODevice.

This class can be used to compress any data written to QIODevice or decompress it back. Compressing data sent over a QTcpSocket is a good example.

Constructor & Destructor Documentation

QuaZIODevice::QuaZIODevice ( QIODevice *  io,
QObject *  parent = NULL 


ioThe QIODevice to read/write.
parentThe parent object, as per QObject logic.

Member Function Documentation

bool QuaZIODevice::flush ( ) [virtual]

Flushes data waiting to be written.

Unfortunately, as QIODevice doesn't support flush() by itself, the only thing this method does is write the compressed data into the device using Z_SYNC_FLUSH mode. If you need the compressed data to actually be flushed from the buffer of the underlying QIODevice, you need to call its flush() method as well, providing it supports it (like QTcpSocket does). Example:

    QuaZIODevice dev(&sock);
    sock->flush(); // this actually sends data to network

This may change in the future versions of QuaZIP by implementing an ugly hack: trying to cast the QIODevice using qobject_cast to known flush()-supporting subclasses, and calling flush if the resulting pointer is not zero.

Referenced by close().

bool QuaZIODevice::open ( QIODevice::OpenMode  mode) [virtual]

Opens the device.

modeNeither QIODevice::ReadWrite nor QIODevice::Append are not supported.
void QuaZIODevice::close ( ) [virtual]

Closes this device, but not the underlying one.

The underlying QIODevice is not closed in case you want to write something else to it.

References flush().

Referenced by ~QuaZIODevice().

The documentation for this class was generated from the following files: