doc/html/tqdatasink.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<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&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;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 &lt;<a href="tqasyncio-h.html">tqasyncio.h</a>&gt;</tt>
<p>Inherits <a href="tqasyncio.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&nbsp;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="tqasyncio.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="tqasyncio.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&nbsp;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 &copy; 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 &copy; 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>