diff options
Diffstat (limited to 'doc/html/tqdatasink.html')
| -rw-r--r-- | doc/html/tqdatasink.html | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/doc/html/tqdatasink.html b/doc/html/tqdatasink.html new file mode 100644 index 000000000..acad5beb0 --- /dev/null +++ b/doc/html/tqdatasink.html @@ -0,0 +1,93 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qasyncio.cpp:85 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>TQDataSink Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td valign=center> + <a href="index.html"> +<font color="#004faf">Home</font></a> + | <a href="classes.html"> +<font color="#004faf">All Classes</font></a> + | <a href="mainclasses.html"> +<font color="#004faf">Main Classes</font></a> + | <a href="annotated.html"> +<font color="#004faf">Annotated</font></a> + | <a href="groups.html"> +<font color="#004faf">Grouped Classes</font></a> + | <a href="functions.html"> +<font color="#004faf">Functions</font></a> +</td> +<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>TQDataSink Class Reference<br><small>[obsolete]</small></h1> + +<p>The TQDataSink class is an asynchronous consumer of data. +<a href="#details">More...</a> +<p><tt>#include <<a href="qasyncio-h.html">ntqasyncio.h</a>></tt> +<p>Inherits <a href="ntqasyncio.html">TQAsyncIO</a>. +<p><a href="tqdatasink-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn>virtual int <a href="#readyToReceive"><b>readyToReceive</b></a> () = 0</li> +<li class=fn>virtual void <a href="#receive"><b>receive</b></a> ( const uchar *, int count ) = 0</li> +<li class=fn>virtual void <a href="#eof"><b>eof</b></a> () = 0</li> +<li class=fn>void <a href="#maybeReady"><b>maybeReady</b></a> ()</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +<b>This class is obsolete.</b> It is provided to keep old source working. We strongly advise against using it in new code. +<p> The TQDataSink class is an asynchronous consumer of data. +<p> A data sink is an object which receives data from some source in an +asynchronous manner. This means that at some time not determined by +the data sink, blocks of data are given to it from processing. The +data sink is able to limit the maximum size of such blocks which it +is currently able to process. +<p> <p>See also <a href="ntqasyncio.html">TQAsyncIO</a>, <a href="tqdatasource.html">TQDataSource</a>, and <a href="tqdatapump.html">TQDataPump</a>. + +<hr><h2>Member Function Documentation</h2> +<h3 class=fn>void <a name="eof"></a>TQDataSink::eof ()<tt> [pure virtual]</tt> +</h3> + +<p> This function will be called when no more data is available for +processing. + +<h3 class=fn>void <a name="maybeReady"></a>TQDataSink::maybeReady () +</h3> +This should be called whenever <a href="#readyToReceive">readyToReceive</a>() might have become non-zero. +It is merely calls <a href="ntqasyncio.html#ready">TQAsyncIO::ready</a>() if readyToReceive() is non-zero. + +<h3 class=fn>int <a name="readyToReceive"></a>TQDataSink::readyToReceive ()<tt> [pure virtual]</tt> +</h3> + +<p> The data sink should return a value indicating how much data it is ready +to consume. This may be 0. + +<h3 class=fn>void <a name="receive"></a>TQDataSink::receive ( const uchar *, int count )<tt> [pure virtual]</tt> +</h3> + +<p> This function is called to provide data for the data sink. The <em>count</em> +will be no more than the amount indicated by the most recent call to +<a href="#readyToReceive">readyToReceive</a>(). The sink must use all the provided data. + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">TQt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>TQt 3.3.8</div> +</table></div></address></body> +</html> |