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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XML-Security-C: XSECBinTXFMInputStream Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>XSECBinTXFMInputStream Class Reference<br>
<small>
[<a class="el" href="group__interfaces.html">Classes that interface applications to XML Security C.</a>]</small>
</h1><code>#include <<a class="el" href="XSECBinTXFMInputStream_8hpp-source.html">XSECBinTXFMInputStream.hpp</a>></code>
<p>
Collaboration diagram for XSECBinTXFMInputStream:<p><center><img src="classXSECBinTXFMInputStream__coll__graph.png" border="0" usemap="#XSECBinTXFMInputStream__coll__map" alt="Collaboration graph"></center>
<map name="XSECBinTXFMInputStream__coll__map">
<area href="classTXFMBase.html" shape="rect" coords="202,372,290,396" alt="">
<area href="classTXFMChain.html" shape="rect" coords="301,462,394,486" alt="">
<area href="classXSECNameSpaceExpander.html" shape="rect" coords="8,281,197,305" alt="">
<area href="classXSECSafeBufferFormatter.html" shape="rect" coords="12,190,193,214" alt="">
<area href="classsafeBuffer.html" shape="rect" coords="89,9,172,33" alt="">
<area href="classsbFormatTarget.html" shape="rect" coords="180,100,297,124" alt="">
<area href="classXSECXPathNodeList.html" shape="rect" coords="221,281,370,305" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXSECBinTXFMInputStream-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
BinInputSource wrapper for a <a class="el" href="classTXFMChain.html">TXFMChain</a>.
<p>
This class provides a wrapper for a <a class="el" href="classTXFMChain.html">TXFMChain</a>. It can be used to either provide a nice interface to applications wishing to read the BYTESTREAM output of a TXFM chain, or, as it is derived from BinInputStream, provide an input to the Xerces Parser.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Interface</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECBinTXFMInputStream.html#z221_0">curPos</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current position in stream. <a href="#z221_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECBinTXFMInputStream.html#z221_1">readBytes</a> (XMLByte *const toFill, const unsigned int maxToRead)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the required number of bytes and return. <a href="#z221_1"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECBinTXFMInputStream.html#z219_0">XSECBinTXFMInputStream</a> (<a class="el" href="classTXFMChain.html">TXFMChain</a> *lst, bool deleteWhenDone=true)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct around an existing transform list. <a href="#z219_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECBinTXFMInputStream.html#z219_1">~XSECBinTXFMInputStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z219_1"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Stream management methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXSECBinTXFMInputStream.html#z220_0">reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the stream. <a href="#z220_0"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z219_0" doxytag="XSECBinTXFMInputStream::XSECBinTXFMInputStream"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">XSECBinTXFMInputStream::XSECBinTXFMInputStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classTXFMChain.html">TXFMChain</a> * </td>
<td class="mdname" nowrap> <em>lst</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>deleteWhenDone</em> = <code>true</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct around an existing transform list.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>lst</em> </td><td>The input TXFM chain. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>deleteWhenDone</em> </td><td>Flag to instruct the class to delete the chain when done. By default set to true. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z219_1" doxytag="XSECBinTXFMInputStream::~XSECBinTXFMInputStream"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual XSECBinTXFMInputStream::~XSECBinTXFMInputStream </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destructor.
<p>
Delete the object. If deleteWhenDone was set during construction, will delete the chain if it has not already been done. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z221_0" doxytag="XSECBinTXFMInputStream::curPos"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual unsigned int XSECBinTXFMInputStream::curPos </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Current position in stream.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Bytes already returned. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z221_1" doxytag="XSECBinTXFMInputStream::readBytes"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual unsigned int XSECBinTXFMInputStream::readBytes </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">XMLByte *const </td>
<td class="mdname" nowrap> <em>toFill</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const unsigned int </td>
<td class="mdname" nowrap> <em>maxToRead</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Retrieve the required number of bytes and return.
<p>
Retrieve up to the requested number of bytes. Does not always retrieve as much as requested, but will always retrieve something until completed.<p>
<dl compact><dt><b>Note:</b></dt><dd>When complete, will return 0 and delete the TXFM chain if requested to do so in the constructor. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>toFill</em> </td><td>The buffer that will be read into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxToRead</em> </td><td>Maximum number of bytes to return </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read or 0 if complete. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z220_0" doxytag="XSECBinTXFMInputStream::reset"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void XSECBinTXFMInputStream::reset </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Reset the stream.
<p>
<dl compact><dt><b>Note:</b></dt><dd>At this time simply deletes the TXFM chain - many TXFMs do not have an ability to reset. </dd></dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XSECBinTXFMInputStream_8hpp-source.html">XSECBinTXFMInputStream.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Jul 3 17:45:11 2005 for XML-Security-C by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
