TorqueEngine
/
Torque2D
镜像来自 https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237
							<!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: Stream 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&amp;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&amp;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> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_stream-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Stream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">

<p>Base stream class for streaming data across a specific media.  
 <a href="class_stream.html#details">More...</a></p>

<p><code>#include &lt;stream.h&gt;</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 Stream:</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_stream.png" usemap="#Stream_map" alt=""/>
  <map id="Stream_map" name="Stream_map">
<area href="class_bit_stream.html" alt="BitStream" shape="rect" coords="0,56,117,80"/>
<area href="class_buffer_stream.html" alt="BufferStream" shape="rect" coords="127,56,244,80"/>
<area href="class_file_stream.html" alt="FileStream" shape="rect" coords="254,56,371,80"/>
<area href="class_filter_stream.html" alt="FilterStream" shape="rect" coords="635,56,752,80"/>
<area href="class_mem_stream.html" alt="MemStream" shape="rect" coords="762,56,879,80"/>
<area href="class_resize_bit_stream.html" alt="ResizeBitStream" shape="rect" coords="0,112,117,136"/>
<area href="class_zip_1_1_zip_temp_stream.html" alt="ZipTempStream" shape="rect" coords="254,112,371,136"/>
<area href="class_resize_filter_stream.html" alt="ResizeFilterStream" shape="rect" coords="381,112,498,136"/>
<area href="class_zip_1_1_zip_stat_filter.html" title="Helper class for tracking CRC and uncompressed size." alt="ZipStatFilter" shape="rect" coords="508,112,625,136"/>
<area href="class_zip_crypt_r_stream.html" alt="ZipCryptRStream" shape="rect" coords="635,112,752,136"/>
<area href="class_zip_sub_r_stream.html" alt="ZipSubRStream" shape="rect" coords="762,112,879,136"/>
<area href="class_zip_sub_w_stream.html" alt="ZipSubWStream" shape="rect" coords="889,112,1006,136"/>
<area href="class_infinite_bit_stream.html" alt="InfiniteBitStream" shape="rect" coords="0,168,117,192"/>
  </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:a67a0db04d321a74b7e7fcfd3f1a3f70b" id="r_a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> { <br />
&#160;&#160;<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 />
&#160;&#160;<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">&#160;</td><td class="mdescRight">Status constantants for the stream.  <a href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">More...</a><br /></td></tr>
<tr class="separator:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4171335401279aad7e5a463349c093c6" id="r_a4171335401279aad7e5a463349c093c6"><td class="memItemLeft" align="right" valign="top">enum &#160;</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"><td class="memSeparator" colspan="2">&#160;</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:a7411b49ed5fda5181dd182d64984906e" id="r_a7411b49ed5fda5181dd182d64984906e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a7411b49ed5fda5181dd182d64984906e">Stream</a> ()</td></tr>
<tr class="separator:a7411b49ed5fda5181dd182d64984906e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22beda3d71a767ab4601c6e3eee69491" id="r_a22beda3d71a767ab4601c6e3eee69491"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a22beda3d71a767ab4601c6e3eee69491">~Stream</a> ()</td></tr>
<tr class="separator:a22beda3d71a767ab4601c6e3eee69491"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2663a82715384e64fab6987cc029e84c" id="r_a2663a82715384e64fab6987cc029e84c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Stream::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a2663a82715384e64fab6987cc029e84c">getStatus</a> () const</td></tr>
<tr class="memdesc:a2663a82715384e64fab6987cc029e84c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the status of the stream.  <br /></td></tr>
<tr class="separator:a2663a82715384e64fab6987cc029e84c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2364a8fe7d4185385b5336af85e6e8aa" id="r_a2364a8fe7d4185385b5336af85e6e8aa"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a2364a8fe7d4185385b5336af85e6e8aa">hasCapability</a> (const <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6">Capability</a>) const =0</td></tr>
<tr class="memdesc:a2364a8fe7d4185385b5336af85e6e8aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks to see if this stream has the capability of a given function.  <br /></td></tr>
<tr class="separator:a2364a8fe7d4185385b5336af85e6e8aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcbf5c2ff0391d5e17c642e2f1452853" id="r_adcbf5c2ff0391d5e17c642e2f1452853"><td class="memItemLeft" align="right" valign="top">virtual U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#adcbf5c2ff0391d5e17c642e2f1452853">getPosition</a> () const =0</td></tr>
<tr class="memdesc:adcbf5c2ff0391d5e17c642e2f1452853"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the position in the stream.  <br /></td></tr>
<tr class="separator:adcbf5c2ff0391d5e17c642e2f1452853"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a813fa6fbeaefd6be02b090ac7f116abc" id="r_a813fa6fbeaefd6be02b090ac7f116abc"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a813fa6fbeaefd6be02b090ac7f116abc">setPosition</a> (const U32 in_newPosition)=0</td></tr>
<tr class="memdesc:a813fa6fbeaefd6be02b090ac7f116abc"><td class="mdescLeft">&#160;</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:a813fa6fbeaefd6be02b090ac7f116abc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f75bbe456f33c8e75a34d5d5993e4ac" id="r_a7f75bbe456f33c8e75a34d5d5993e4ac"><td class="memItemLeft" align="right" valign="top">virtual U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a7f75bbe456f33c8e75a34d5d5993e4ac">getStreamSize</a> ()=0</td></tr>
<tr class="memdesc:a7f75bbe456f33c8e75a34d5d5993e4ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the stream.  <br /></td></tr>
<tr class="separator:a7f75bbe456f33c8e75a34d5d5993e4ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b6a8c8788a8db1f558b682290f965b2" id="r_a3b6a8c8788a8db1f558b682290f965b2"><td class="memItemLeft" align="right" valign="top">void&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23412a482b81d6ff0d3ba16db2cac736" id="r_a23412a482b81d6ff0d3ba16db2cac736"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a23412a482b81d6ff0d3ba16db2cac736">writeLine</a> (U8 *buffer)</td></tr>
<tr class="memdesc:a23412a482b81d6ff0d3ba16db2cac736"><td class="mdescLeft">&#160;</td><td class="mdescRight">writes a line to the stream  <br /></td></tr>
<tr class="separator:a23412a482b81d6ff0d3ba16db2cac736"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c2c648097af54af55117de280ecf6f1" id="r_a7c2c648097af54af55117de280ecf6f1"><td class="memItemLeft" align="right" valign="top">const char *&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fbd4b3661401a422e85c500f5abd29b" id="r_a2fbd4b3661401a422e85c500f5abd29b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a string of maximum 255 characters long.  <br /></td></tr>
<tr class="separator:a2fbd4b3661401a422e85c500f5abd29b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad828e07ac7a5772761d2c4900b5d0f26" id="r_ad828e07ac7a5772761d2c4900b5d0f26"><td class="memItemLeft" align="right" valign="top">void&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68cc7469413cfaf6a91304b3ad16c989" id="r_a68cc7469413cfaf6a91304b3ad16c989"><td class="memItemLeft" align="right" valign="top">void&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85fde001c721c92b173c97f75ac7a34f" id="r_a85fde001c721c92b173c97f75ac7a34f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a85fde001c721c92b173c97f75ac7a34f">Put</a> (char character)</td></tr>
<tr class="separator:a85fde001c721c92b173c97f75ac7a34f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a156ee70ed74214c0c58538019c3e609f" id="r_a156ee70ed74214c0c58538019c3e609f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a string to the stream.  <br /></td></tr>
<tr class="separator:a156ee70ed74214c0c58538019c3e609f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ca83baf06d1ce99112281e037f2cbc3" id="r_a1ca83baf06d1ce99112281e037f2cbc3"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a824b52708cc986f47d6a5de8c50300d5" id="r_a824b52708cc986f47d6a5de8c50300d5"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a NULL terminated string buffer.  <br /></td></tr>
<tr class="separator:a824b52708cc986f47d6a5de8c50300d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9a1ef53f7ed4a70a01613d14e92b2dc" id="r_ab9a1ef53f7ed4a70a01613d14e92b2dc"><td class="memItemLeft" align="right" valign="top">bool&#160;</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> &amp;)</td></tr>
<tr class="memdesc:ab9a1ef53f7ed4a70a01613d14e92b2dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write an integral color to the stream.  <br /></td></tr>
<tr class="separator:ab9a1ef53f7ed4a70a01613d14e92b2dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac17b0c849807a64b7b8c09c3b3993590" id="r_ac17b0c849807a64b7b8c09c3b3993590"><td class="memItemLeft" align="right" valign="top">bool&#160;</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> &amp;)</td></tr>
<tr class="memdesc:ac17b0c849807a64b7b8c09c3b3993590"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a floating point color to the stream.  <br /></td></tr>
<tr class="separator:ac17b0c849807a64b7b8c09c3b3993590"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e6037eb5db2c7e1193fecb70cd9c59a" id="r_a3e6037eb5db2c7e1193fecb70cd9c59a"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read an integral color from the stream.  <br /></td></tr>
<tr class="separator:a3e6037eb5db2c7e1193fecb70cd9c59a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9aa8dd9deecbcd40be97d95c8782d0d" id="r_af9aa8dd9deecbcd40be97d95c8782d0d"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a floating point color from the stream.  <br /></td></tr>
<tr class="separator:af9aa8dd9deecbcd40be97d95c8782d0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dc0218bb53ed07ba09506b7c1f62e4b" id="r_a1dc0218bb53ed07ba09506b7c1f62e4b"><td class="memItemLeft" align="right" valign="top">bool&#160;</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> &amp;)</td></tr>
<tr class="memdesc:a1dc0218bb53ed07ba09506b7c1f62e4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a network address to the stream.  <br /></td></tr>
<tr class="separator:a1dc0218bb53ed07ba09506b7c1f62e4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04b731dbfb2c7c4057abfa6d3fc0b1c1" id="r_a04b731dbfb2c7c4057abfa6d3fc0b1c1"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a network address from the stream.  <br /></td></tr>
<tr class="separator:a04b731dbfb2c7c4057abfa6d3fc0b1c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64a7badfd176a5f129c060b7e49c3dcc" id="r_a64a7badfd176a5f129c060b7e49c3dcc"><td class="memItemLeft" align="right" valign="top">bool&#160;</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> &amp;)</td></tr>
<tr class="memdesc:a64a7badfd176a5f129c060b7e49c3dcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a network socket to the stream.  <br /></td></tr>
<tr class="separator:a64a7badfd176a5f129c060b7e49c3dcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae04694c3a9f0bca8216f93244cfbe893" id="r_ae04694c3a9f0bca8216f93244cfbe893"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a network socket from the stream.  <br /></td></tr>
<tr class="separator:ae04694c3a9f0bca8216f93244cfbe893"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a523d4b06e675df8e9c87e2366d207267" id="r_a523d4b06e675df8e9c87e2366d207267"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcb32d3374fda3848d85604ef33bf237" id="r_afcb32d3374fda3848d85604ef33bf237"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a168060372c9991186bb2e50520614e16" id="r_a168060372c9991186bb2e50520614e16"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00ae09a31e3fa0f23b451f88f89ee755" id="r_a00ae09a31e3fa0f23b451f88f89ee755"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a00ae09a31e3fa0f23b451f88f89ee755">write</a> (const bool &amp;in_rWrite)</td></tr>
<tr class="separator:a00ae09a31e3fa0f23b451f88f89ee755"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdb0e38e209e1c014d0f2c10bc9127d2" id="r_acdb0e38e209e1c014d0f2c10bc9127d2"><td class="memItemLeft" align="right" valign="top">bool&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy the contents of another stream into this one.  <br /></td></tr>
<tr class="separator:acdb0e38e209e1c014d0f2c10bc9127d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5c791c6efecee2afe477af5199f1e4f" id="r_ad5c791c6efecee2afe477af5199f1e4f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ad5c791c6efecee2afe477af5199f1e4f">writeTabs</a> (U32 count)</td></tr>
<tr class="memdesc:ad5c791c6efecee2afe477af5199f1e4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write a number of tabs to this stream.  <br /></td></tr>
<tr class="separator:ad5c791c6efecee2afe477af5199f1e4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4bf9a6c6f388ed0d137d5ded0fd86ead" id="r_a4bf9a6c6f388ed0d137d5ded0fd86ead"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</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"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a printable string form of the status.  <br /></td></tr>
<tr class="separator:a4bf9a6c6f388ed0d137d5ded0fd86ead"><td class="memSeparator" colspan="2">&#160;</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:a4bcd5e78dcdb4115e417b9d95de1f88e" id="r_a4bcd5e78dcdb4115e417b9d95de1f88e"><td class="memItemLeft" align="right" valign="top">void&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a773fde4a45c9aaeac3cec389fae8a1e0" id="r_a773fde4a45c9aaeac3cec389fae8a1e0"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#a773fde4a45c9aaeac3cec389fae8a1e0">_read</a> (const U32 in_numBytes, void *out_pBuffer)=0</td></tr>
<tr class="separator:a773fde4a45c9aaeac3cec389fae8a1e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2e5ce9f07d6f9ac70d319d8db8ca82e" id="r_ab2e5ce9f07d6f9ac70d319d8db8ca82e"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_stream.html#ab2e5ce9f07d6f9ac70d319d8db8ca82e">_write</a> (const U32 in_numBytes, const void *in_pBuffer)=0</td></tr>
<tr class="separator:ab2e5ce9f07d6f9ac70d319d8db8ca82e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base stream class for streaming data across a specific media. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a4171335401279aad7e5a463349c093c6" name="a4171335401279aad7e5a463349c093c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4171335401279aad7e5a463349c093c6">&#9670;&#160;</a></span>Capability</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_stream.html#a4171335401279aad7e5a463349c093c6">Capability</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4171335401279aad7e5a463349c093c6a8b38409f320f118d34803056f9c4ea3b" name="a4171335401279aad7e5a463349c093c6a8b38409f320f118d34803056f9c4ea3b"></a>StreamWrite&#160;</td><td class="fielddoc"><p>Can this stream write? </p>
</td></tr>
<tr><td class="fieldname"><a id="a4171335401279aad7e5a463349c093c6a086614a0f074a4c74b661a636d915a6b" name="a4171335401279aad7e5a463349c093c6a086614a0f074a4c74b661a636d915a6b"></a>StreamRead&#160;</td><td class="fielddoc"><p>Can this stream read? </p>
</td></tr>
<tr><td class="fieldname"><a id="a4171335401279aad7e5a463349c093c6ab1207c45b01a44c072b04ccaff4a241d" name="a4171335401279aad7e5a463349c093c6ab1207c45b01a44c072b04ccaff4a241d"></a>StreamPosition&#160;</td><td class="fielddoc"><p>Can this stream position? </p>
</td></tr>
</table>

</div>
</div>
<a id="a67a0db04d321a74b7e7fcfd3f1a3f70b" name="a67a0db04d321a74b7e7fcfd3f1a3f70b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67a0db04d321a74b7e7fcfd3f1a3f70b">&#9670;&#160;</a></span>Status</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Status constantants for the stream. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba06d32f047358de4e6a30c28046f4688e" name="a67a0db04d321a74b7e7fcfd3f1a3f70ba06d32f047358de4e6a30c28046f4688e"></a>Ok&#160;</td><td class="fielddoc"><p>Ok! </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba53ea0cae152133005a5dbe9a1329765c" name="a67a0db04d321a74b7e7fcfd3f1a3f70ba53ea0cae152133005a5dbe9a1329765c"></a>IOError&#160;</td><td class="fielddoc"><p>Read or Write error. </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70bae4953b2aea10c683c1f4990a11e01d4d" name="a67a0db04d321a74b7e7fcfd3f1a3f70bae4953b2aea10c683c1f4990a11e01d4d"></a>EOS&#160;</td><td class="fielddoc"><p>End of <a class="el" href="class_stream.html" title="Base stream class for streaming data across a specific media.">Stream</a> reached (mostly for reads) </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70baa359c7ce2440768125c74d431817548a" name="a67a0db04d321a74b7e7fcfd3f1a3f70baa359c7ce2440768125c74d431817548a"></a>IllegalCall&#160;</td><td class="fielddoc"><p>An unsupported operation used. Always w/ accompanied by AssertWarn. </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba30c0b4dad1e3a3b93f822b9cef26244b" name="a67a0db04d321a74b7e7fcfd3f1a3f70ba30c0b4dad1e3a3b93f822b9cef26244b"></a>Closed&#160;</td><td class="fielddoc"><p>Tried to operate on a closed stream (or detached filter) </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba36b13bee92e122caddcb8abefb6eec31" name="a67a0db04d321a74b7e7fcfd3f1a3f70ba36b13bee92e122caddcb8abefb6eec31"></a>UnknownError&#160;</td><td class="fielddoc"><p>Catchall. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7411b49ed5fda5181dd182d64984906e" name="a7411b49ed5fda5181dd182d64984906e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7411b49ed5fda5181dd182d64984906e">&#9670;&#160;</a></span>Stream()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_stream.html">Stream</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a22beda3d71a767ab4601c6e3eee69491" name="a22beda3d71a767ab4601c6e3eee69491"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22beda3d71a767ab4601c6e3eee69491">&#9670;&#160;</a></span>~Stream()</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_stream.html">Stream</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="a773fde4a45c9aaeac3cec389fae8a1e0" name="a773fde4a45c9aaeac3cec389fae8a1e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a773fde4a45c9aaeac3cec389fae8a1e0">&#9670;&#160;</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">virtual bool _read </td>
          <td>(</td>
          <td class="paramtype">const U32&#160;</td>
          <td class="paramname"><em>in_numBytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>out_pBuffer</em>&#160;</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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_buffer_stream.html#a9c22c178d21ff861c16c4562a763189d">BufferStream</a>, <a class="el" href="class_file_stream.html#a9c22c178d21ff861c16c4562a763189d">FileStream</a>, <a class="el" href="class_filter_stream.html#a206acb5479110dce4221f0fdb2cf923b">FilterStream</a>, <a class="el" href="class_mem_stream.html#a206acb5479110dce4221f0fdb2cf923b">MemStream</a>, <a class="el" href="class_resize_filter_stream.html#a206acb5479110dce4221f0fdb2cf923b">ResizeFilterStream</a>, <a class="el" href="class_zip_crypt_r_stream.html#a206acb5479110dce4221f0fdb2cf923b">ZipCryptRStream</a>, <a class="el" href="class_zip_sub_r_stream.html#a206acb5479110dce4221f0fdb2cf923b">ZipSubRStream</a>, <a class="el" href="class_zip_sub_w_stream.html#a206acb5479110dce4221f0fdb2cf923b">ZipSubWStream</a>, <a class="el" href="class_zip_1_1_zip_stat_filter.html#a3d5a2edbef8b08d909a2755412508e77">ZipStatFilter</a>, and <a class="el" href="class_bit_stream.html#a0a403cce7735fc105c407a80e662b817">BitStream</a>.</p>

</div>
</div>
<a id="ab2e5ce9f07d6f9ac70d319d8db8ca82e" name="ab2e5ce9f07d6f9ac70d319d8db8ca82e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2e5ce9f07d6f9ac70d319d8db8ca82e">&#9670;&#160;</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">virtual bool _write </td>
          <td>(</td>
          <td class="paramtype">const U32&#160;</td>
          <td class="paramname"><em>in_numBytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>in_pBuffer</em>&#160;</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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implemented in <a class="el" href="class_buffer_stream.html#a917f99ea335a66aa1278891fbaa0c69c">BufferStream</a>, <a class="el" href="class_file_stream.html#a917f99ea335a66aa1278891fbaa0c69c">FileStream</a>, <a class="el" href="class_filter_stream.html#a83ec3afe7a94eb23b653ad29799dac44">FilterStream</a>, <a class="el" href="class_mem_stream.html#a83ec3afe7a94eb23b653ad29799dac44">MemStream</a>, <a class="el" href="class_zip_sub_w_stream.html#a83ec3afe7a94eb23b653ad29799dac44">ZipSubWStream</a>, <a class="el" href="class_zip_1_1_zip_stat_filter.html#a0220af012fef8e93891b3804a64e4298">ZipStatFilter</a>, and <a class="el" href="class_bit_stream.html#a657dfac771511a524e77f2890acb9b2d">BitStream</a>.</p>

</div>
</div>
<a id="acdb0e38e209e1c014d0f2c10bc9127d2" name="acdb0e38e209e1c014d0f2c10bc9127d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdb0e38e209e1c014d0f2c10bc9127d2">&#9670;&#160;</a></span>copyFrom()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool copyFrom </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_stream.html">Stream</a> *&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copy the contents of another stream into this one. </p>

</div>
</div>
<a id="adcbf5c2ff0391d5e17c642e2f1452853" name="adcbf5c2ff0391d5e17c642e2f1452853"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcbf5c2ff0391d5e17c642e2f1452853">&#9670;&#160;</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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the position in the stream. </p>

<p>Implemented in <a class="el" href="class_bit_stream.html#ae91252bdbffcafaefaa6edec813a3c1e">BitStream</a>, <a class="el" href="class_buffer_stream.html#a1565cf8a216a120cb19549baadc523a7">BufferStream</a>, <a class="el" href="class_file_stream.html#ae91252bdbffcafaefaa6edec813a3c1e">FileStream</a>, <a class="el" href="class_filter_stream.html#ae91252bdbffcafaefaa6edec813a3c1e">FilterStream</a>, <a class="el" href="class_mem_stream.html#ae91252bdbffcafaefaa6edec813a3c1e">MemStream</a>, <a class="el" href="class_resize_filter_stream.html#ae91252bdbffcafaefaa6edec813a3c1e">ResizeFilterStream</a>, <a class="el" href="class_zip_crypt_r_stream.html#ae91252bdbffcafaefaa6edec813a3c1e">ZipCryptRStream</a>, <a class="el" href="class_zip_sub_r_stream.html#ae91252bdbffcafaefaa6edec813a3c1e">ZipSubRStream</a>, and <a class="el" href="class_zip_sub_w_stream.html#ae91252bdbffcafaefaa6edec813a3c1e">ZipSubWStream</a>.</p>

</div>
</div>
<a id="a2663a82715384e64fab6987cc029e84c" name="a2663a82715384e64fab6987cc029e84c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2663a82715384e64fab6987cc029e84c">&#9670;&#160;</a></span>getStatus()</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_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Stream::Status</a> getStatus </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>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the status of the stream. </p>

</div>
</div>
<a id="a4bf9a6c6f388ed0d137d5ded0fd86ead" name="a4bf9a6c6f388ed0d137d5ded0fd86ead"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bf9a6c6f388ed0d137d5ded0fd86ead">&#9670;&#160;</a></span>getStatusString()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char * getStatusString </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td>
          <td class="paramname"><em>in_status</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets a printable string form of the status. </p>

</div>
</div>
<a id="a7f75bbe456f33c8e75a34d5d5993e4ac" name="a7f75bbe456f33c8e75a34d5d5993e4ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f75bbe456f33c8e75a34d5d5993e4ac">&#9670;&#160;</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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the size of the stream. </p>

<p>Implemented in <a class="el" href="class_bit_stream.html#aaa67310324a7402bcca80535b361e287">BitStream</a>, <a class="el" href="class_buffer_stream.html#a3c773f7c6ea74ffed149c20beada035f">BufferStream</a>, <a class="el" href="class_file_stream.html#aaa67310324a7402bcca80535b361e287">FileStream</a>, <a class="el" href="class_filter_stream.html#aaa67310324a7402bcca80535b361e287">FilterStream</a>, <a class="el" href="class_mem_stream.html#aaa67310324a7402bcca80535b361e287">MemStream</a>, <a class="el" href="class_resize_filter_stream.html#aaa67310324a7402bcca80535b361e287">ResizeFilterStream</a>, <a class="el" href="class_zip_sub_r_stream.html#aaa67310324a7402bcca80535b361e287">ZipSubRStream</a>, and <a class="el" href="class_zip_sub_w_stream.html#aaa67310324a7402bcca80535b361e287">ZipSubWStream</a>.</p>

</div>
</div>
<a id="a2364a8fe7d4185385b5336af85e6e8aa" name="a2364a8fe7d4185385b5336af85e6e8aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2364a8fe7d4185385b5336af85e6e8aa">&#9670;&#160;</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>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure 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>Implemented in <a class="el" href="class_buffer_stream.html#ae7bafe214d93a9a0ea6b62694575a350">BufferStream</a>, <a class="el" href="class_file_stream.html#ac9b5a7153e82dc56e88e5d427de6d8b7">FileStream</a>, <a class="el" href="class_bit_stream.html#ab5dbb9b7af17446b991b439e4186cf7d">BitStream</a>, <a class="el" href="class_filter_stream.html#ab5dbb9b7af17446b991b439e4186cf7d">FilterStream</a>, <a class="el" href="class_mem_stream.html#ab5dbb9b7af17446b991b439e4186cf7d">MemStream</a>, <a class="el" href="class_zip_sub_r_stream.html#ab5dbb9b7af17446b991b439e4186cf7d">ZipSubRStream</a>, and <a class="el" href="class_zip_sub_w_stream.html#ab5dbb9b7af17446b991b439e4186cf7d">ZipSubWStream</a>.</p>

</div>
</div>
<a id="a85fde001c721c92b173c97f75ac7a34f" name="a85fde001c721c92b173c97f75ac7a34f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85fde001c721c92b173c97f75ac7a34f">&#9670;&#160;</a></span>Put()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool Put </td>
          <td>(</td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname"><em>character</em></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="a168060372c9991186bb2e50520614e16" name="a168060372c9991186bb2e50520614e16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a168060372c9991186bb2e50520614e16">&#9670;&#160;</a></span>read() <span class="overload">[1/6]</span></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">bool *&#160;</td>
          <td class="paramname"><em>out_pRead</em></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="af9aa8dd9deecbcd40be97d95c8782d0d" name="af9aa8dd9deecbcd40be97d95c8782d0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9aa8dd9deecbcd40be97d95c8782d0d">&#9670;&#160;</a></span>read() <span class="overload">[2/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_color_f.html">ColorF</a> *&#160;</td>
          <td class="paramname"><em>pColor</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read a floating point color from the stream. </p>

</div>
</div>
<a id="a3e6037eb5db2c7e1193fecb70cd9c59a" name="a3e6037eb5db2c7e1193fecb70cd9c59a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e6037eb5db2c7e1193fecb70cd9c59a">&#9670;&#160;</a></span>read() <span class="overload">[3/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_color_i.html">ColorI</a> *&#160;</td>
          <td class="paramname"><em>pColor</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read an integral color from the stream. </p>

</div>
</div>
<a id="a523d4b06e675df8e9c87e2366d207267" name="a523d4b06e675df8e9c87e2366d207267"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a523d4b06e675df8e9c87e2366d207267">&#9670;&#160;</a></span>read() <span class="overload">[4/6]</span></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&#160;</td>
          <td class="paramname"><em>in_numBytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>out_pBuffer</em>&#160;</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>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a04b731dbfb2c7c4057abfa6d3fc0b1c1" name="a04b731dbfb2c7c4057abfa6d3fc0b1c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04b731dbfb2c7c4057abfa6d3fc0b1c1">&#9670;&#160;</a></span>read() <span class="overload">[5/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_net_address.html">NetAddress</a> *&#160;</td>
          <td class="paramname"><em>na</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read a network address from the stream. </p>

</div>
</div>
<a id="ae04694c3a9f0bca8216f93244cfbe893" name="ae04694c3a9f0bca8216f93244cfbe893"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae04694c3a9f0bca8216f93244cfbe893">&#9670;&#160;</a></span>read() <span class="overload">[6/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_net_socket.html">NetSocket</a> *&#160;</td>
          <td class="paramname"><em>so</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Read a network socket from the stream. </p>

</div>
</div>
<a id="a3b6a8c8788a8db1f558b682290f965b2" name="a3b6a8c8788a8db1f558b682290f965b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b6a8c8788a8db1f558b682290f965b2">&#9670;&#160;</a></span>readLine()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void readLine </td>
          <td>(</td>
          <td class="paramtype">U8 *&#160;</td>
          <td class="paramname"><em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>bufferSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Reads a line from the stream. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>buffer to be read into </td></tr>
    <tr><td class="paramname">bufferSize</td><td>max size of the buffer. Will not read more than the "bufferSize" </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ad828e07ac7a5772761d2c4900b5d0f26" name="ad828e07ac7a5772761d2c4900b5d0f26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad828e07ac7a5772761d2c4900b5d0f26">&#9670;&#160;</a></span>readLongString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void readLongString </td>
          <td>(</td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>maxStringLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>stringBuf</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Reads a string that could potentially be more than 255 characters long. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">maxStringLen</td><td>Maximum length to read. If the string is longer than maxStringLen, only maxStringLen bytes will be read. </td></tr>
    <tr><td class="paramname">stringBuf</td><td>buffer where data is read into </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a2fbd4b3661401a422e85c500f5abd29b" name="a2fbd4b3661401a422e85c500f5abd29b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fbd4b3661401a422e85c500f5abd29b">&#9670;&#160;</a></span>readString()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void readString </td>
          <td>(</td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname"><em>stringBuf</em>[256]</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">

<p>Reads a string of maximum 255 characters long. </p>

<p>Reimplemented in <a class="el" href="class_bit_stream.html#a2fbd4b3661401a422e85c500f5abd29b">BitStream</a>.</p>

</div>
</div>
<a id="a7c2c648097af54af55117de280ecf6f1" name="a7c2c648097af54af55117de280ecf6f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c2c648097af54af55117de280ecf6f1">&#9670;&#160;</a></span>readSTString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char * readSTString </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>casesens</em> = <code>false</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Reads a string and inserts it into the StringTable </p><dl class="section see"><dt>See also</dt><dd>StringTable </dd></dl>

</div>
</div>
<a id="a813fa6fbeaefd6be02b090ac7f116abc" name="a813fa6fbeaefd6be02b090ac7f116abc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a813fa6fbeaefd6be02b090ac7f116abc">&#9670;&#160;</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&#160;</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">pure 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>Implemented in <a class="el" href="class_buffer_stream.html#ab2f5f68611f8eb0ac9c723ae68855590">BufferStream</a>, <a class="el" href="class_file_stream.html#a75d0bd9d352b99b88457e772a43df38d">FileStream</a>, <a class="el" href="class_zip_1_1_zip_temp_stream.html#ab2f5f68611f8eb0ac9c723ae68855590">ZipTempStream</a>, <a class="el" href="class_bit_stream.html#afc5a28d52cfac4cba9bf64e1de373653">BitStream</a>, <a class="el" href="class_filter_stream.html#afc5a28d52cfac4cba9bf64e1de373653">FilterStream</a>, <a class="el" href="class_mem_stream.html#afc5a28d52cfac4cba9bf64e1de373653">MemStream</a>, <a class="el" href="class_resize_filter_stream.html#afc5a28d52cfac4cba9bf64e1de373653">ResizeFilterStream</a>, <a class="el" href="class_zip_crypt_r_stream.html#afc5a28d52cfac4cba9bf64e1de373653">ZipCryptRStream</a>, <a class="el" href="class_zip_sub_r_stream.html#afc5a28d52cfac4cba9bf64e1de373653">ZipSubRStream</a>, and <a class="el" href="class_zip_sub_w_stream.html#afc5a28d52cfac4cba9bf64e1de373653">ZipSubWStream</a>.</p>

</div>
</div>
<a id="a4bcd5e78dcdb4115e417b9d95de1f88e" name="a4bcd5e78dcdb4115e417b9d95de1f88e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bcd5e78dcdb4115e417b9d95de1f88e">&#9670;&#160;</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="paramtype">const <a class="el" href="class_stream.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td>
          <td class="paramname"><em>in_newStatus</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="a00ae09a31e3fa0f23b451f88f89ee755" name="a00ae09a31e3fa0f23b451f88f89ee755"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00ae09a31e3fa0f23b451f88f89ee755">&#9670;&#160;</a></span>write() <span class="overload">[1/6]</span></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 bool &amp;&#160;</td>
          <td class="paramname"><em>in_rWrite</em></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="ac17b0c849807a64b7b8c09c3b3993590" name="ac17b0c849807a64b7b8c09c3b3993590"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac17b0c849807a64b7b8c09c3b3993590">&#9670;&#160;</a></span>write() <span class="overload">[2/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool write </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_color_f.html">ColorF</a> &amp;&#160;</td>
          <td class="paramname"><em>rColor</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Write a floating point color to the stream. </p>

</div>
</div>
<a id="ab9a1ef53f7ed4a70a01613d14e92b2dc" name="ab9a1ef53f7ed4a70a01613d14e92b2dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9a1ef53f7ed4a70a01613d14e92b2dc">&#9670;&#160;</a></span>write() <span class="overload">[3/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool write </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_color_i.html">ColorI</a> &amp;&#160;</td>
          <td class="paramname"><em>rColor</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Write an integral color to the stream. </p>

</div>
</div>
<a id="a1dc0218bb53ed07ba09506b7c1f62e4b" name="a1dc0218bb53ed07ba09506b7c1f62e4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dc0218bb53ed07ba09506b7c1f62e4b">&#9670;&#160;</a></span>write() <span class="overload">[4/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool write </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_net_address.html">NetAddress</a> &amp;&#160;</td>
          <td class="paramname"><em>na</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Write a network address to the stream. </p>

</div>
</div>
<a id="a64a7badfd176a5f129c060b7e49c3dcc" name="a64a7badfd176a5f129c060b7e49c3dcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64a7badfd176a5f129c060b7e49c3dcc">&#9670;&#160;</a></span>write() <span class="overload">[5/6]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool write </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_net_socket.html">NetSocket</a> &amp;&#160;</td>
          <td class="paramname"><em>so</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Write a network socket to the stream. </p>

</div>
</div>
<a id="afcb32d3374fda3848d85604ef33bf237" name="afcb32d3374fda3848d85604ef33bf237"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcb32d3374fda3848d85604ef33bf237">&#9670;&#160;</a></span>write() <span class="overload">[6/6]</span></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&#160;</td>
          <td class="paramname"><em>in_numBytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const void *&#160;</td>
          <td class="paramname"><em>in_pBuffer</em>&#160;</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>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a1ca83baf06d1ce99112281e037f2cbc3" name="a1ca83baf06d1ce99112281e037f2cbc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ca83baf06d1ce99112281e037f2cbc3">&#9670;&#160;</a></span>writeFormattedBuffer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool writeFormattedBuffer </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Writes a formatted buffer to the stream. NOTE: A maximum string length of 4K is allowed. </p>

</div>
</div>
<a id="a23412a482b81d6ff0d3ba16db2cac736" name="a23412a482b81d6ff0d3ba16db2cac736"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23412a482b81d6ff0d3ba16db2cac736">&#9670;&#160;</a></span>writeLine()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void writeLine </td>
          <td>(</td>
          <td class="paramtype">U8 *&#160;</td>
          <td class="paramname"><em>buffer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>writes a line to the stream </p>

</div>
</div>
<a id="a68cc7469413cfaf6a91304b3ad16c989" name="a68cc7469413cfaf6a91304b3ad16c989"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68cc7469413cfaf6a91304b3ad16c989">&#9670;&#160;</a></span>writeLongString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void writeLongString </td>
          <td>(</td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>maxStringLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>string</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Writes a string to the stream. This function is slightly unstable. Only use this if you have a valid string that is not empty. writeString is safer. </p>

</div>
</div>
<a id="a156ee70ed74214c0c58538019c3e609f" name="a156ee70ed74214c0c58538019c3e609f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a156ee70ed74214c0c58538019c3e609f">&#9670;&#160;</a></span>writeString()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void writeString </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>stringBuf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>maxLen</em> = <code>255</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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">

<p>Writes a string to the stream. </p>

<p>Reimplemented in <a class="el" href="class_bit_stream.html#a156ee70ed74214c0c58538019c3e609f">BitStream</a>.</p>

</div>
</div>
<a id="a824b52708cc986f47d6a5de8c50300d5" name="a824b52708cc986f47d6a5de8c50300d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a824b52708cc986f47d6a5de8c50300d5">&#9670;&#160;</a></span>writeStringBuffer()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool writeStringBuffer </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>buffer</em></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">

<p>Writes a NULL terminated string buffer. </p>

</div>
</div>
<a id="ad5c791c6efecee2afe477af5199f1e4f" name="ad5c791c6efecee2afe477af5199f1e4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5c791c6efecee2afe477af5199f1e4f">&#9670;&#160;</a></span>writeTabs()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void writeTabs </td>
          <td>(</td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>count</em></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">

<p>Write a number of tabs to this stream. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>io/<b>stream.h</b></li>
<li>io/<b>nStream.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>