1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nw::io::IOStream</title> 51 </head> 52 <body> 53 <h1><CODE>nw::io::IOStream</CODE> Class</h1> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class IOStream</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>The file stream base class.</p><p>This is the base class for performing operations on data file streams. Implementation is carried out using derived classes.</p></div> 61 <a name="typedef" id="typedef"> 62 <h2><CODE>typedef</CODE> Definitions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100" /> 67 <th> 68 <a href="../../../nw/io/IOStream/IOStreamCallback.html">IOStreamCallback</a> 69 </th> 70 <td>This callback function is called after asynchronous processing completes.</td> 71 </tr> </table> 72 </div> 73 </a> <a name="variable" id="variable"> 74 <h2>Member Variables</h2> 75 <div class="section"> 76 <table class="members"> 77 <tr> 78 <td width="100"> </td> 79 <th> 80 <span class="argument"><CODE>NW_UT_RUNTIME_TYPEINFO</CODE></span> 81 </th> 82 <td> 83 </td> 84 </tr> 85 <tr> 86 <td width="100"> 87 <span class="protected_style" title="protected">protected</span> </td> 88 <th> 89 <span class="argument">mAvailable</span> 90 </th> 91 <td> 92 </td> 93 </tr> 94 <tr> 95 <td width="100"> 96 <span class="protected_style" title="protected">protected</span> </td> 97 <th> 98 <span class="argument">mAsyncResult</span> 99 </th> 100 <td> 101 </td> 102 </tr> 103 <tr> 104 <td width="100"> 105 <span class="protected_style" title="protected">protected</span> </td> 106 <th> 107 <span class="argument">mCallback</span> 108 </th> 109 <td> 110 </td> 111 </tr> 112 <tr> 113 <td width="100"> 114 <span class="protected_style" title="protected">protected</span> </td> 115 <th> 116 <span class="argument">mArg</span> 117 </th> 118 <td> 119 </td> 120 </tr> </table> 121 </div> 122 </a> <a name="function" id="function"> 123 <h2>Member Functions</h2> 124 <div class="section"> 125 <table class="members"> 126 <tr> 127 <th class="category" colspan="3">Constructors/Destructors</th> 128 </tr> 129 <tr> 130 <td width="100"> <span class="virtual_style" title="virtual">V</span> 131 </td> 132 <th> 133 <a href="../../../nw/io/IOStream/~IOStream.html">~IOStream</a> 134 </th> 135 <td>Destructor.</td> 136 </tr> 137 <tr> 138 <td width="100"> 139 <span class="protected_style" title="protected">protected</span> </td> 140 <th> 141 <a href="../../../nw/io/IOStream/IOStream.html">IOStream</a> 142 </th> 143 <td>Constructor.</td> 144 </tr> 145 <tr> 146 <th class="category" colspan="3">Gets the property information of the file stream.</th> 147 </tr> 148 <tr> 149 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 150 </td> 151 <th> 152 <a href="../../../nw/io/IOStream/CanRead.html">CanRead</a> 153 </th> 154 <td>Gets whether this stream can be read.</td> 155 </tr> 156 <tr> 157 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 158 </td> 159 <th> 160 <a href="../../../nw/io/IOStream/CanWrite.html">CanWrite</a> 161 </th> 162 <td>Gets whether this stream can be written.</td> 163 </tr> 164 <tr> 165 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 166 </td> 167 <th> 168 <a href="../../../nw/io/IOStream/CanAsync.html">CanAsync</a> 169 </th> 170 <td>Gets whether this stream can be processed asynchronously.</td> 171 </tr> 172 <tr> 173 <td width="100"> <span class="virtual_style" title="virtual">V</span> 174 </td> 175 <th> 176 <a href="../../../nw/io/IOStream/GetOffsetAlign.html">GetOffsetAlign</a> 177 </th> 178 <td>Gets the alignment required as an offset position from the file pointer used when reading/writing files.</td> 179 </tr> 180 <tr> 181 <td width="100"> <span class="virtual_style" title="virtual">V</span> 182 </td> 183 <th> 184 <a href="../../../nw/io/IOStream/GetSizeAlign.html">GetSizeAlign</a> 185 </th> 186 <td>Gets the alignment required as a size to be read/written once when reading/writing files.</td> 187 </tr> 188 <tr> 189 <td width="100"> <span class="virtual_style" title="virtual">V</span> 190 </td> 191 <th> 192 <a href="../../../nw/io/IOStream/GetBufferAlign.html">GetBufferAlign</a> 193 </th> 194 <td>This function gets the alignment required for a buffer address used for sending/receiving data when reading/writing.</td> 195 </tr> 196 <tr> 197 <th class="category" colspan="3">File Stream Operations</th> 198 </tr> 199 <tr> 200 <td width="100"> <span class="virtual_style" title="virtual">V</span> 201 </td> 202 <th> 203 <a href="../../../nw/io/IOStream/Read.html"><CODE>Read</CODE></a> 204 </th> 205 <td>Reads data from the stream (synchronous process).</td> 206 </tr> 207 <tr> 208 <td width="100"> <span class="virtual_style" title="virtual">V</span> 209 </td> 210 <th> 211 <a href="../../../nw/io/IOStream/ReadAsync.html">ReadAsync</a> 212 </th> 213 <td>Reads data from the stream (asynchronous process).</td> 214 </tr> 215 <tr> 216 <td width="100"> <span class="virtual_style" title="virtual">V</span> 217 </td> 218 <th> 219 <a href="../../../nw/io/IOStream/Write.html"><CODE>Write</CODE></a> 220 </th> 221 <td>Writes data to the stream (synchronous process).</td> 222 </tr> 223 <tr> 224 <td width="100"> <span class="virtual_style" title="virtual">V</span> 225 </td> 226 <th> 227 <a href="../../../nw/io/IOStream/WriteAsync.html">WriteAsync</a> 228 </th> 229 <td>Writes data to the stream (asynchronous process).</td> 230 </tr> 231 <tr> 232 <td width="100"> </td> 233 <th> 234 <a href="../../../nw/io/IOStream/WaitAsync.html">WaitAsync</a> 235 </th> 236 <td>Waits for the completion of asynchronous processing.</td> 237 </tr> 238 <tr> 239 <td width="100"> <span class="virtual_style" title="virtual">V</span> 240 </td> 241 <th> 242 <a href="../../../nw/io/IOStream/IsBusy.html"><CODE>IsBusy</CODE></a> 243 </th> 244 <td>Checks whether asynchronous processing is currently executing.</td> 245 </tr> 246 <tr> 247 <th class="category" colspan="3">Closes the file/gets status</th> 248 </tr> 249 <tr> 250 <td width="100"> <span class="virtual_style" title="pure-virtual">PV</span> 251 </td> 252 <th> 253 <a href="../../../nw/io/IOStream/Close.html"><CODE>Close</CODE></a> 254 </th> 255 <td>Closes a stream.</td> 256 </tr> 257 <tr> 258 <td width="100"> </td> 259 <th> 260 <a href="../../../nw/io/IOStream/IsAvailable.html">IsAvailable</a> 261 </th> 262 <td>Gets a value indicating whether the stream is currently available.</td> 263 </tr> </table> 264 </div> 265 </a> 266 <h2>Revision History</h2> 267 <div class="section"> 268 <dl class="history"> 269 <dt>2009/10/20</dt> 270 <dd>Initial version.<br /> 271 </dd> 272 </dl> 273 </div> 274 <hr><p>CONFIDENTIAL</p></body> 275</html>