QDataSource(3qt)

NAME
QDataSource - Asynchronous producer of data

#include <qasyncio.h>

Inherits QAsyncIO.

Inherited by QIODeviceSource.

  Public Members
virtual int readyToSend ()
virtual void sendTo ( QDataSink *, int count )
void maybeReady ()
virtual bool rewindable () const
virtual void enableRewind ( bool )
virtual void rewind ()

DESCRIPTION
The QDataSource class is an asynchronous producer of data.

A data source is an object which provides data from some source in an asynchronous manner. This means that at some time not determined by the data source, blocks of data will be taken from it for processing. The data source is able to limit the maximum size of such blocks which it is currently able to provide.

See also QAsyncIO, QDataSink and QDataPump.

MEMBER FUNCTION DOCUMENTATION

void QDataSource::enableRewind ( bool ) [virtual]
If this function is called with on set to TRUE, and rewindable() is TRUE, then the data source must take measures to allow the rewind() function to subsequently operate as described. If rewindable() is FALSE, the function should call QDataSource::enableRewind(), which aborts with a qFatal() error.

For example, a network connection may choose to utilize a disk cache of input only if rewinding is enabled before the first buffer-full of data is discarded, returning FALSE in rewindable() if that first buffer is discarded.

Reimplemented in QIODeviceSource.

void QDataSource::maybeReady ()
This should be called whenever readyToSend() might have become non-zero. It is merely calls QAsyncIO::ready() if readyToSend() is non-zero.

int QDataSource::readyToSend () [virtual]
The data source should return a value indicating how much data it is ready to provide. This may be 0. If the data source knows it will never be able to provide any more data (until after a rewind()), it may return -1.

Reimplemented in QIODeviceSource.

void QDataSource::rewind () [virtual]
This function rewinds the data source. This may only be called if enableRewind(TRUE) has been previously called.

Reimplemented in QIODeviceSource.

bool QDataSource::rewindable () const [virtual]
This function should return TRUE if the data source can be rewound.

The default returns FALSE.

Reimplemented in QIODeviceSource.

void QDataSource::sendTo ( QDataSink *, int count ) [virtual]
This function is called to extract data from the source, by sending it to the given data sink. The count will be no more than the amount indicated by the most recent call to readyToSend(). The source must use all the provided data, and the sink will be prepared to accept at least this much data.

Reimplemented in QIODeviceSource.

SEE ALSO
http://doc.trolltech.com/qdatasource.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
Copyright 1992-2001 Trolltech AS, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.

BUGS
If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports make our job much simpler. Thank you.

In case of content or formattting problems with this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qdatasource.3qt) and the Qt version (2.3.1).