| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Torque2D Reference: BufferStream Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">Torque2D Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-types">Public Types</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="#pro-static-methods">Static Protected Member Functions</a> |
- <a href="#pro-attribs">Protected Attributes</a> |
- <a href="class_buffer_stream-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">BufferStream Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <bufferStream.h></code></p>
- <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
- <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for BufferStream:</div>
- <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
- </div>
- <div id="dynsection-0-content" class="dyncontent" style="display:none;">
- <div class="center">
- <img src="class_buffer_stream.png" usemap="#BufferStream_map" alt=""/>
- <map id="BufferStream_map" name="BufferStream_map">
- <area href="class_stream.html" title="Base stream class for streaming data across a specific media." alt="Stream" shape="rect" coords="0,0,86,24"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
- Public Types</h2></td></tr>
- <tr class="memitem:a05589fbab0657f08285ebdfe93f5ec9e" id="r_a05589fbab0657f08285ebdfe93f5ec9e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="class_buffer_stream.html#a05589fbab0657f08285ebdfe93f5ec9ea1a63387ea87dae07937bf38548748733">BUFFER_SIZE</a> = 8 * 1024
- , <a class="el" href="class_buffer_stream.html#a05589fbab0657f08285ebdfe93f5ec9ea4c9e74658923bde10a0f25eaf32a5be2">BUFFER_INVALID</a> = 0xffffffff
- }</td></tr>
- <tr class="separator:a05589fbab0657f08285ebdfe93f5ec9e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_types_class_stream"><td colspan="2" onclick="javascript:toggleInherit('pub_types_class_stream')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="class_stream.html">Stream</a></td></tr>
- <tr class="memitem:a67a0db04d321a74b7e7fcfd3f1a3f70b inherit pub_types_class_stream" id="r_a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> { <br />
-   <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba06d32f047358de4e6a30c28046f4688e">Ok</a> = 0
- , <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba53ea0cae152133005a5dbe9a1329765c">IOError</a>
- , <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70bae4953b2aea10c683c1f4990a11e01d4d">EOS</a>
- , <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70baa359c7ce2440768125c74d431817548a">IllegalCall</a>
- , <br />
-   <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba30c0b4dad1e3a3b93f822b9cef26244b">Closed</a>
- , <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba36b13bee92e122caddcb8abefb6eec31">UnknownError</a>
- <br />
- }</td></tr>
- <tr class="memdesc:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="mdescLeft"> </td><td class="mdescRight">Status constantants for the stream. <a href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">More...</a><br /></td></tr>
- <tr class="separator:a67a0db04d321a74b7e7fcfd3f1a3f70b inherit pub_types_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4171335401279aad7e5a463349c093c6 inherit pub_types_class_stream" id="r_a4171335401279aad7e5a463349c093c6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6">Capability</a> { <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6a8b38409f320f118d34803056f9c4ea3b">StreamWrite</a> = BIT(0)
- , <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6a086614a0f074a4c74b661a636d915a6b">StreamRead</a> = BIT(1)
- , <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6ab1207c45b01a44c072b04ccaff4a241d">StreamPosition</a> = BIT(2)
- }</td></tr>
- <tr class="separator:a4171335401279aad7e5a463349c093c6 inherit pub_types_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a2e9907a25f5c5e10eaa2489fb059a022" id="r_a2e9907a25f5c5e10eaa2489fb059a022"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a2e9907a25f5c5e10eaa2489fb059a022">BufferStream</a> ()</td></tr>
- <tr class="separator:a2e9907a25f5c5e10eaa2489fb059a022"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9fea95e9b976c8ead41a15aef9e8f448" id="r_a9fea95e9b976c8ead41a15aef9e8f448"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a9fea95e9b976c8ead41a15aef9e8f448">~BufferStream</a> ()</td></tr>
- <tr class="separator:a9fea95e9b976c8ead41a15aef9e8f448"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae7bafe214d93a9a0ea6b62694575a350" id="r_ae7bafe214d93a9a0ea6b62694575a350"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#ae7bafe214d93a9a0ea6b62694575a350">hasCapability</a> (const <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6">Capability</a> i_cap) const</td></tr>
- <tr class="memdesc:ae7bafe214d93a9a0ea6b62694575a350"><td class="mdescLeft"> </td><td class="mdescRight">Checks to see if this stream has the capability of a given function. <br /></td></tr>
- <tr class="separator:ae7bafe214d93a9a0ea6b62694575a350"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1565cf8a216a120cb19549baadc523a7" id="r_a1565cf8a216a120cb19549baadc523a7"><td class="memItemLeft" align="right" valign="top">virtual U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a1565cf8a216a120cb19549baadc523a7">getPosition</a> () const</td></tr>
- <tr class="memdesc:a1565cf8a216a120cb19549baadc523a7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the position in the stream. <br /></td></tr>
- <tr class="separator:a1565cf8a216a120cb19549baadc523a7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab2f5f68611f8eb0ac9c723ae68855590" id="r_ab2f5f68611f8eb0ac9c723ae68855590"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#ab2f5f68611f8eb0ac9c723ae68855590">setPosition</a> (const U32 i_newPosition)</td></tr>
- <tr class="memdesc:ab2f5f68611f8eb0ac9c723ae68855590"><td class="mdescLeft"> </td><td class="mdescRight">Sets the position of the stream. Returns if the new position is valid or not. <br /></td></tr>
- <tr class="separator:ab2f5f68611f8eb0ac9c723ae68855590"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3c773f7c6ea74ffed149c20beada035f" id="r_a3c773f7c6ea74ffed149c20beada035f"><td class="memItemLeft" align="right" valign="top">virtual U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a3c773f7c6ea74ffed149c20beada035f">getStreamSize</a> ()</td></tr>
- <tr class="memdesc:a3c773f7c6ea74ffed149c20beada035f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the size of the stream. <br /></td></tr>
- <tr class="separator:a3c773f7c6ea74ffed149c20beada035f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5ae591df94fc66ccb85cbb6565368bca" id="r_a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
- <tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9e8555112049fc2b4945120b3c45f8ab" id="r_a9e8555112049fc2b4945120b3c45f8ab"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a9e8555112049fc2b4945120b3c45f8ab">open</a> ()</td></tr>
- <tr class="separator:a9e8555112049fc2b4945120b3c45f8ab"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4c2db21bdf0f71bcb0d7fe2479ced1f7" id="r_a4c2db21bdf0f71bcb0d7fe2479ced1f7"><td class="memItemLeft" align="right" valign="top">U8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a4c2db21bdf0f71bcb0d7fe2479ced1f7">getBuffer</a> ()</td></tr>
- <tr class="separator:a4c2db21bdf0f71bcb0d7fe2479ced1f7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aad599519dd7000fc2f50516f63877217" id="r_aad599519dd7000fc2f50516f63877217"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#aad599519dd7000fc2f50516f63877217">getBufferLength</a> ()</td></tr>
- <tr class="separator:aad599519dd7000fc2f50516f63877217"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_stream"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_stream')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_stream.html">Stream</a></td></tr>
- <tr class="memitem:a7411b49ed5fda5181dd182d64984906e inherit pub_methods_class_stream" id="r_a7411b49ed5fda5181dd182d64984906e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a7411b49ed5fda5181dd182d64984906e">Stream</a> ()</td></tr>
- <tr class="separator:a7411b49ed5fda5181dd182d64984906e inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a22beda3d71a767ab4601c6e3eee69491 inherit pub_methods_class_stream" id="r_a22beda3d71a767ab4601c6e3eee69491"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a22beda3d71a767ab4601c6e3eee69491">~Stream</a> ()</td></tr>
- <tr class="separator:a22beda3d71a767ab4601c6e3eee69491 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2663a82715384e64fab6987cc029e84c inherit pub_methods_class_stream" id="r_a2663a82715384e64fab6987cc029e84c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Stream::Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a2663a82715384e64fab6987cc029e84c">getStatus</a> () const</td></tr>
- <tr class="memdesc:a2663a82715384e64fab6987cc029e84c inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Gets the status of the stream. <br /></td></tr>
- <tr class="separator:a2663a82715384e64fab6987cc029e84c inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3b6a8c8788a8db1f558b682290f965b2 inherit pub_methods_class_stream" id="r_a3b6a8c8788a8db1f558b682290f965b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a3b6a8c8788a8db1f558b682290f965b2">readLine</a> (U8 *buffer, U32 bufferSize)</td></tr>
- <tr class="separator:a3b6a8c8788a8db1f558b682290f965b2 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a23412a482b81d6ff0d3ba16db2cac736 inherit pub_methods_class_stream" id="r_a23412a482b81d6ff0d3ba16db2cac736"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a23412a482b81d6ff0d3ba16db2cac736">writeLine</a> (U8 *buffer)</td></tr>
- <tr class="memdesc:a23412a482b81d6ff0d3ba16db2cac736 inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">writes a line to the stream <br /></td></tr>
- <tr class="separator:a23412a482b81d6ff0d3ba16db2cac736 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7c2c648097af54af55117de280ecf6f1 inherit pub_methods_class_stream" id="r_a7c2c648097af54af55117de280ecf6f1"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a7c2c648097af54af55117de280ecf6f1">readSTString</a> (bool casesens=false)</td></tr>
- <tr class="separator:a7c2c648097af54af55117de280ecf6f1 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2fbd4b3661401a422e85c500f5abd29b inherit pub_methods_class_stream" id="r_a2fbd4b3661401a422e85c500f5abd29b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a2fbd4b3661401a422e85c500f5abd29b">readString</a> (char stringBuf[256])</td></tr>
- <tr class="memdesc:a2fbd4b3661401a422e85c500f5abd29b inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Reads a string of maximum 255 characters long. <br /></td></tr>
- <tr class="separator:a2fbd4b3661401a422e85c500f5abd29b inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad828e07ac7a5772761d2c4900b5d0f26 inherit pub_methods_class_stream" id="r_ad828e07ac7a5772761d2c4900b5d0f26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ad828e07ac7a5772761d2c4900b5d0f26">readLongString</a> (U32 maxStringLen, char *stringBuf)</td></tr>
- <tr class="separator:ad828e07ac7a5772761d2c4900b5d0f26 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a68cc7469413cfaf6a91304b3ad16c989 inherit pub_methods_class_stream" id="r_a68cc7469413cfaf6a91304b3ad16c989"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a68cc7469413cfaf6a91304b3ad16c989">writeLongString</a> (U32 maxStringLen, const char *string)</td></tr>
- <tr class="separator:a68cc7469413cfaf6a91304b3ad16c989 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85fde001c721c92b173c97f75ac7a34f inherit pub_methods_class_stream" id="r_a85fde001c721c92b173c97f75ac7a34f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a85fde001c721c92b173c97f75ac7a34f">Put</a> (char character)</td></tr>
- <tr class="separator:a85fde001c721c92b173c97f75ac7a34f inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a156ee70ed74214c0c58538019c3e609f inherit pub_methods_class_stream" id="r_a156ee70ed74214c0c58538019c3e609f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a156ee70ed74214c0c58538019c3e609f">writeString</a> (const char *stringBuf, S32 maxLen=255)</td></tr>
- <tr class="memdesc:a156ee70ed74214c0c58538019c3e609f inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Writes a string to the stream. <br /></td></tr>
- <tr class="separator:a156ee70ed74214c0c58538019c3e609f inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1ca83baf06d1ce99112281e037f2cbc3 inherit pub_methods_class_stream" id="r_a1ca83baf06d1ce99112281e037f2cbc3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a1ca83baf06d1ce99112281e037f2cbc3">writeFormattedBuffer</a> (const char *format,...)</td></tr>
- <tr class="separator:a1ca83baf06d1ce99112281e037f2cbc3 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a824b52708cc986f47d6a5de8c50300d5 inherit pub_methods_class_stream" id="r_a824b52708cc986f47d6a5de8c50300d5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a824b52708cc986f47d6a5de8c50300d5">writeStringBuffer</a> (const char *buffer)</td></tr>
- <tr class="memdesc:a824b52708cc986f47d6a5de8c50300d5 inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Writes a NULL terminated string buffer. <br /></td></tr>
- <tr class="separator:a824b52708cc986f47d6a5de8c50300d5 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab9a1ef53f7ed4a70a01613d14e92b2dc inherit pub_methods_class_stream" id="r_ab9a1ef53f7ed4a70a01613d14e92b2dc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ab9a1ef53f7ed4a70a01613d14e92b2dc">write</a> (const <a class="el" href="class_color_i.html">ColorI</a> &)</td></tr>
- <tr class="memdesc:ab9a1ef53f7ed4a70a01613d14e92b2dc inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Write an integral color to the stream. <br /></td></tr>
- <tr class="separator:ab9a1ef53f7ed4a70a01613d14e92b2dc inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac17b0c849807a64b7b8c09c3b3993590 inherit pub_methods_class_stream" id="r_ac17b0c849807a64b7b8c09c3b3993590"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ac17b0c849807a64b7b8c09c3b3993590">write</a> (const <a class="el" href="class_color_f.html">ColorF</a> &)</td></tr>
- <tr class="memdesc:ac17b0c849807a64b7b8c09c3b3993590 inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Write a floating point color to the stream. <br /></td></tr>
- <tr class="separator:ac17b0c849807a64b7b8c09c3b3993590 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3e6037eb5db2c7e1193fecb70cd9c59a inherit pub_methods_class_stream" id="r_a3e6037eb5db2c7e1193fecb70cd9c59a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a3e6037eb5db2c7e1193fecb70cd9c59a">read</a> (<a class="el" href="class_color_i.html">ColorI</a> *)</td></tr>
- <tr class="memdesc:a3e6037eb5db2c7e1193fecb70cd9c59a inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Read an integral color from the stream. <br /></td></tr>
- <tr class="separator:a3e6037eb5db2c7e1193fecb70cd9c59a inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af9aa8dd9deecbcd40be97d95c8782d0d inherit pub_methods_class_stream" id="r_af9aa8dd9deecbcd40be97d95c8782d0d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#af9aa8dd9deecbcd40be97d95c8782d0d">read</a> (<a class="el" href="class_color_f.html">ColorF</a> *)</td></tr>
- <tr class="memdesc:af9aa8dd9deecbcd40be97d95c8782d0d inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Read a floating point color from the stream. <br /></td></tr>
- <tr class="separator:af9aa8dd9deecbcd40be97d95c8782d0d inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1dc0218bb53ed07ba09506b7c1f62e4b inherit pub_methods_class_stream" id="r_a1dc0218bb53ed07ba09506b7c1f62e4b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a1dc0218bb53ed07ba09506b7c1f62e4b">write</a> (const <a class="el" href="struct_net_address.html">NetAddress</a> &)</td></tr>
- <tr class="memdesc:a1dc0218bb53ed07ba09506b7c1f62e4b inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Write a network address to the stream. <br /></td></tr>
- <tr class="separator:a1dc0218bb53ed07ba09506b7c1f62e4b inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a04b731dbfb2c7c4057abfa6d3fc0b1c1 inherit pub_methods_class_stream" id="r_a04b731dbfb2c7c4057abfa6d3fc0b1c1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a04b731dbfb2c7c4057abfa6d3fc0b1c1">read</a> (<a class="el" href="struct_net_address.html">NetAddress</a> *)</td></tr>
- <tr class="memdesc:a04b731dbfb2c7c4057abfa6d3fc0b1c1 inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Read a network address from the stream. <br /></td></tr>
- <tr class="separator:a04b731dbfb2c7c4057abfa6d3fc0b1c1 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a64a7badfd176a5f129c060b7e49c3dcc inherit pub_methods_class_stream" id="r_a64a7badfd176a5f129c060b7e49c3dcc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a64a7badfd176a5f129c060b7e49c3dcc">write</a> (const <a class="el" href="class_net_socket.html">NetSocket</a> &)</td></tr>
- <tr class="memdesc:a64a7badfd176a5f129c060b7e49c3dcc inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Write a network socket to the stream. <br /></td></tr>
- <tr class="separator:a64a7badfd176a5f129c060b7e49c3dcc inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae04694c3a9f0bca8216f93244cfbe893 inherit pub_methods_class_stream" id="r_ae04694c3a9f0bca8216f93244cfbe893"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ae04694c3a9f0bca8216f93244cfbe893">read</a> (<a class="el" href="class_net_socket.html">NetSocket</a> *)</td></tr>
- <tr class="memdesc:ae04694c3a9f0bca8216f93244cfbe893 inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Read a network socket from the stream. <br /></td></tr>
- <tr class="separator:ae04694c3a9f0bca8216f93244cfbe893 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a523d4b06e675df8e9c87e2366d207267 inherit pub_methods_class_stream" id="r_a523d4b06e675df8e9c87e2366d207267"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a523d4b06e675df8e9c87e2366d207267">read</a> (const U32 in_numBytes, void *out_pBuffer)</td></tr>
- <tr class="separator:a523d4b06e675df8e9c87e2366d207267 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afcb32d3374fda3848d85604ef33bf237 inherit pub_methods_class_stream" id="r_afcb32d3374fda3848d85604ef33bf237"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#afcb32d3374fda3848d85604ef33bf237">write</a> (const U32 in_numBytes, const void *in_pBuffer)</td></tr>
- <tr class="separator:afcb32d3374fda3848d85604ef33bf237 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a168060372c9991186bb2e50520614e16 inherit pub_methods_class_stream" id="r_a168060372c9991186bb2e50520614e16"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a168060372c9991186bb2e50520614e16">read</a> (bool *out_pRead)</td></tr>
- <tr class="separator:a168060372c9991186bb2e50520614e16 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a00ae09a31e3fa0f23b451f88f89ee755 inherit pub_methods_class_stream" id="r_a00ae09a31e3fa0f23b451f88f89ee755"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a00ae09a31e3fa0f23b451f88f89ee755">write</a> (const bool &in_rWrite)</td></tr>
- <tr class="separator:a00ae09a31e3fa0f23b451f88f89ee755 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acdb0e38e209e1c014d0f2c10bc9127d2 inherit pub_methods_class_stream" id="r_acdb0e38e209e1c014d0f2c10bc9127d2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#acdb0e38e209e1c014d0f2c10bc9127d2">copyFrom</a> (<a class="el" href="class_stream.html">Stream</a> *other)</td></tr>
- <tr class="memdesc:acdb0e38e209e1c014d0f2c10bc9127d2 inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Copy the contents of another stream into this one. <br /></td></tr>
- <tr class="separator:acdb0e38e209e1c014d0f2c10bc9127d2 inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad5c791c6efecee2afe477af5199f1e4f inherit pub_methods_class_stream" id="r_ad5c791c6efecee2afe477af5199f1e4f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ad5c791c6efecee2afe477af5199f1e4f">writeTabs</a> (U32 count)</td></tr>
- <tr class="memdesc:ad5c791c6efecee2afe477af5199f1e4f inherit pub_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Write a number of tabs to this stream. <br /></td></tr>
- <tr class="separator:ad5c791c6efecee2afe477af5199f1e4f inherit pub_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:a9c22c178d21ff861c16c4562a763189d" id="r_a9c22c178d21ff861c16c4562a763189d"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a9c22c178d21ff861c16c4562a763189d">_read</a> (const U32 i_numBytes, void *o_pBuffer)</td></tr>
- <tr class="separator:a9c22c178d21ff861c16c4562a763189d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a917f99ea335a66aa1278891fbaa0c69c" id="r_a917f99ea335a66aa1278891fbaa0c69c"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a917f99ea335a66aa1278891fbaa0c69c">_write</a> (const U32 i_numBytes, const void *i_pBuffer)</td></tr>
- <tr class="separator:a917f99ea335a66aa1278891fbaa0c69c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a02fd73d861ef2e4aabb38c0c9ff82947" id="r_a02fd73d861ef2e4aabb38c0c9ff82947"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a02fd73d861ef2e4aabb38c0c9ff82947">init</a> ()</td></tr>
- <tr class="separator:a02fd73d861ef2e4aabb38c0c9ff82947"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0bee1cb2fd69b9faf87a2edb4073231c" id="r_a0bee1cb2fd69b9faf87a2edb4073231c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a0bee1cb2fd69b9faf87a2edb4073231c">fillBuffer</a> (const U32 i_startPosition)</td></tr>
- <tr class="separator:a0bee1cb2fd69b9faf87a2edb4073231c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a20bbd4d45e3f01305dd709f5a9cc9952" id="r_a20bbd4d45e3f01305dd709f5a9cc9952"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a20bbd4d45e3f01305dd709f5a9cc9952">clearBuffer</a> ()</td></tr>
- <tr class="separator:a20bbd4d45e3f01305dd709f5a9cc9952"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab929dbde7295e6977cf35377d79b09f1" id="r_ab929dbde7295e6977cf35377d79b09f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#ab929dbde7295e6977cf35377d79b09f1">setStatus</a> ()</td></tr>
- <tr class="separator:ab929dbde7295e6977cf35377d79b09f1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_class_stream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_stream')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_stream.html">Stream</a></td></tr>
- <tr class="memitem:a4bcd5e78dcdb4115e417b9d95de1f88e inherit pro_methods_class_stream" id="r_a4bcd5e78dcdb4115e417b9d95de1f88e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a4bcd5e78dcdb4115e417b9d95de1f88e">setStatus</a> (const <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> in_newStatus)</td></tr>
- <tr class="separator:a4bcd5e78dcdb4115e417b9d95de1f88e inherit pro_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
- Static Protected Member Functions</h2></td></tr>
- <tr class="memitem:a2e967df288565c13aedfcbf66c62e126" id="r_a2e967df288565c13aedfcbf66c62e126"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#a2e967df288565c13aedfcbf66c62e126">calcBlockHead</a> (const U32 i_position, U32 *o_blockHead)</td></tr>
- <tr class="separator:a2e967df288565c13aedfcbf66c62e126"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac8a82d1a20f7654c811f1e61016cadff" id="r_ac8a82d1a20f7654c811f1e61016cadff"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#ac8a82d1a20f7654c811f1e61016cadff">calcBlockBounds</a> (const U32 i_position, U32 *o_blockHead, U32 *o_blockTail)</td></tr>
- <tr class="separator:ac8a82d1a20f7654c811f1e61016cadff"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
- Protected Attributes</h2></td></tr>
- <tr class="memitem:ac0f2b09d8aeebe6cd3cf7d618203cfc9" id="r_ac0f2b09d8aeebe6cd3cf7d618203cfc9"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#ac0f2b09d8aeebe6cd3cf7d618203cfc9">mBufferLen</a></td></tr>
- <tr class="separator:ac0f2b09d8aeebe6cd3cf7d618203cfc9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa3bd177dd2868fcaaee40344c46e6ac5" id="r_aa3bd177dd2868fcaaee40344c46e6ac5"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#aa3bd177dd2868fcaaee40344c46e6ac5">mReadPosition</a></td></tr>
- <tr class="separator:aa3bd177dd2868fcaaee40344c46e6ac5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af0b836f42e76b45209253de4193e0bb5" id="r_af0b836f42e76b45209253de4193e0bb5"><td class="memItemLeft" align="right" valign="top">U8 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_buffer_stream.html#af0b836f42e76b45209253de4193e0bb5">mBuffer</a> [<a class="el" href="class_buffer_stream.html#a05589fbab0657f08285ebdfe93f5ec9ea1a63387ea87dae07937bf38548748733">BUFFER_SIZE</a>]</td></tr>
- <tr class="separator:af0b836f42e76b45209253de4193e0bb5"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <tr class="inherit_header pub_static_methods_class_stream"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_stream')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_stream.html">Stream</a></td></tr>
- <tr class="memitem:a4bf9a6c6f388ed0d137d5ded0fd86ead inherit pub_static_methods_class_stream" id="r_a4bf9a6c6f388ed0d137d5ded0fd86ead"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a4bf9a6c6f388ed0d137d5ded0fd86ead">getStatusString</a> (const <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> in_status)</td></tr>
- <tr class="memdesc:a4bf9a6c6f388ed0d137d5ded0fd86ead inherit pub_static_methods_class_stream"><td class="mdescLeft"> </td><td class="mdescRight">Gets a printable string form of the status. <br /></td></tr>
- <tr class="separator:a4bf9a6c6f388ed0d137d5ded0fd86ead inherit pub_static_methods_class_stream"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Enumeration Documentation</h2>
- <a id="a05589fbab0657f08285ebdfe93f5ec9e" name="a05589fbab0657f08285ebdfe93f5ec9e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a05589fbab0657f08285ebdfe93f5ec9e">◆ </a></span>anonymous enum</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">anonymous enum</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a05589fbab0657f08285ebdfe93f5ec9ea1a63387ea87dae07937bf38548748733" name="a05589fbab0657f08285ebdfe93f5ec9ea1a63387ea87dae07937bf38548748733"></a>BUFFER_SIZE </td><td class="fielddoc"></td></tr>
- <tr><td class="fieldname"><a id="a05589fbab0657f08285ebdfe93f5ec9ea4c9e74658923bde10a0f25eaf32a5be2" name="a05589fbab0657f08285ebdfe93f5ec9ea4c9e74658923bde10a0f25eaf32a5be2"></a>BUFFER_INVALID </td><td class="fielddoc"></td></tr>
- </table>
- </div>
- </div>
- <h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a2e9907a25f5c5e10eaa2489fb059a022" name="a2e9907a25f5c5e10eaa2489fb059a022"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2e9907a25f5c5e10eaa2489fb059a022">◆ </a></span>BufferStream()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_buffer_stream.html">BufferStream</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a9fea95e9b976c8ead41a15aef9e8f448" name="a9fea95e9b976c8ead41a15aef9e8f448"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9fea95e9b976c8ead41a15aef9e8f448">◆ </a></span>~BufferStream()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">~<a class="el" href="class_buffer_stream.html">BufferStream</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a9c22c178d21ff861c16c4562a763189d" name="a9c22c178d21ff861c16c4562a763189d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9c22c178d21ff861c16c4562a763189d">◆ </a></span>_read()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool _read </td>
- <td>(</td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>i_numBytes</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>o_pBuffer</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implements <a class="el" href="class_stream.html#a773fde4a45c9aaeac3cec389fae8a1e0">Stream</a>.</p>
- </div>
- </div>
- <a id="a917f99ea335a66aa1278891fbaa0c69c" name="a917f99ea335a66aa1278891fbaa0c69c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a917f99ea335a66aa1278891fbaa0c69c">◆ </a></span>_write()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool _write </td>
- <td>(</td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>i_numBytes</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>i_pBuffer</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implements <a class="el" href="class_stream.html#ab2e5ce9f07d6f9ac70d319d8db8ca82e">Stream</a>.</p>
- </div>
- </div>
- <a id="ac8a82d1a20f7654c811f1e61016cadff" name="ac8a82d1a20f7654c811f1e61016cadff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac8a82d1a20f7654c811f1e61016cadff">◆ </a></span>calcBlockBounds()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void calcBlockBounds </td>
- <td>(</td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>i_position</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 * </td>
- <td class="paramname"><em>o_blockHead</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 * </td>
- <td class="paramname"><em>o_blockTail</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a2e967df288565c13aedfcbf66c62e126" name="a2e967df288565c13aedfcbf66c62e126"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2e967df288565c13aedfcbf66c62e126">◆ </a></span>calcBlockHead()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void calcBlockHead </td>
- <td>(</td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>i_position</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 * </td>
- <td class="paramname"><em>o_blockHead</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a20bbd4d45e3f01305dd709f5a9cc9952" name="a20bbd4d45e3f01305dd709f5a9cc9952"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a20bbd4d45e3f01305dd709f5a9cc9952">◆ </a></span>clearBuffer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void clearBuffer </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a5ae591df94fc66ccb85cbb6565368bca" name="a5ae591df94fc66ccb85cbb6565368bca"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5ae591df94fc66ccb85cbb6565368bca">◆ </a></span>close()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void close </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a0bee1cb2fd69b9faf87a2edb4073231c" name="a0bee1cb2fd69b9faf87a2edb4073231c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0bee1cb2fd69b9faf87a2edb4073231c">◆ </a></span>fillBuffer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool fillBuffer </td>
- <td>(</td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>i_startPosition</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a4c2db21bdf0f71bcb0d7fe2479ced1f7" name="a4c2db21bdf0f71bcb0d7fe2479ced1f7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4c2db21bdf0f71bcb0d7fe2479ced1f7">◆ </a></span>getBuffer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U8 * getBuffer </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aad599519dd7000fc2f50516f63877217" name="aad599519dd7000fc2f50516f63877217"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aad599519dd7000fc2f50516f63877217">◆ </a></span>getBufferLength()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 getBufferLength </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a1565cf8a216a120cb19549baadc523a7" name="a1565cf8a216a120cb19549baadc523a7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1565cf8a216a120cb19549baadc523a7">◆ </a></span>getPosition()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual U32 getPosition </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the position in the stream. </p>
- <p>Implements <a class="el" href="class_stream.html#adcbf5c2ff0391d5e17c642e2f1452853">Stream</a>.</p>
- </div>
- </div>
- <a id="a3c773f7c6ea74ffed149c20beada035f" name="a3c773f7c6ea74ffed149c20beada035f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3c773f7c6ea74ffed149c20beada035f">◆ </a></span>getStreamSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual U32 getStreamSize </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the size of the stream. </p>
- <p>Implements <a class="el" href="class_stream.html#a7f75bbe456f33c8e75a34d5d5993e4ac">Stream</a>.</p>
- </div>
- </div>
- <a id="ae7bafe214d93a9a0ea6b62694575a350" name="ae7bafe214d93a9a0ea6b62694575a350"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae7bafe214d93a9a0ea6b62694575a350">◆ </a></span>hasCapability()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool hasCapability </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6">Capability</a> </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Checks to see if this stream has the capability of a given function. </p>
- <p>Implements <a class="el" href="class_stream.html#a2364a8fe7d4185385b5336af85e6e8aa">Stream</a>.</p>
- </div>
- </div>
- <a id="a02fd73d861ef2e4aabb38c0c9ff82947" name="a02fd73d861ef2e4aabb38c0c9ff82947"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a02fd73d861ef2e4aabb38c0c9ff82947">◆ </a></span>init()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void init </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a9e8555112049fc2b4945120b3c45f8ab" name="a9e8555112049fc2b4945120b3c45f8ab"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9e8555112049fc2b4945120b3c45f8ab">◆ </a></span>open()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void open </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ab2f5f68611f8eb0ac9c723ae68855590" name="ab2f5f68611f8eb0ac9c723ae68855590"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab2f5f68611f8eb0ac9c723ae68855590">◆ </a></span>setPosition()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool setPosition </td>
- <td>(</td>
- <td class="paramtype">const U32 </td>
- <td class="paramname"><em>in_newPosition</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the position of the stream. Returns if the new position is valid or not. </p>
- <p>Implements <a class="el" href="class_stream.html#a813fa6fbeaefd6be02b090ac7f116abc">Stream</a>.</p>
- </div>
- </div>
- <a id="ab929dbde7295e6977cf35377d79b09f1" name="ab929dbde7295e6977cf35377d79b09f1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab929dbde7295e6977cf35377d79b09f1">◆ </a></span>setStatus()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setStatus </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="af0b836f42e76b45209253de4193e0bb5" name="af0b836f42e76b45209253de4193e0bb5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af0b836f42e76b45209253de4193e0bb5">◆ </a></span>mBuffer</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U8 mBuffer[<a class="el" href="class_buffer_stream.html#a05589fbab0657f08285ebdfe93f5ec9ea1a63387ea87dae07937bf38548748733">BUFFER_SIZE</a>]</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ac0f2b09d8aeebe6cd3cf7d618203cfc9" name="ac0f2b09d8aeebe6cd3cf7d618203cfc9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac0f2b09d8aeebe6cd3cf7d618203cfc9">◆ </a></span>mBufferLen</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 mBufferLen</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aa3bd177dd2868fcaaee40344c46e6ac5" name="aa3bd177dd2868fcaaee40344c46e6ac5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa3bd177dd2868fcaaee40344c46e6ac5">◆ </a></span>mReadPosition</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 mReadPosition</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>io/<b>bufferStream.h</b></li>
- <li>io/<b>bufferStream.cc</b></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|