TorqueEngine
/
Torque2D
zrcadlo https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
							<!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: ConnectionStringTable 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="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_connection_string_table-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ConnectionStringTable Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;connectionStringTable.h&gt;</code></p>
<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:a198b8c2c77ea9f9815a181ddeda1c320" id="r_a198b8c2c77ea9f9815a181ddeda1c320"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connection_string_table.html#a198b8c2c77ea9f9815a181ddeda1c320">Constants</a> { <a class="el" href="class_connection_string_table.html#a198b8c2c77ea9f9815a181ddeda1c320aeba3d28abe6bbf1807d64f4d8d1746fd">EntryCount</a> = 32
, <a class="el" href="class_connection_string_table.html#a198b8c2c77ea9f9815a181ddeda1c320a99512775751f9700f385f0c8084709ae">EntryBitSize</a> = 5
, <a class="el" href="class_connection_string_table.html#a198b8c2c77ea9f9815a181ddeda1c320ab34e7ea5ed0693befd653a5b3d5d8b50">InvalidEntryId</a> = 32
 }</td></tr>
<tr class="separator:a198b8c2c77ea9f9815a181ddeda1c320"><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:a1b6bc933bbd3d7568d38b6fe6a818cc0" id="r_a1b6bc933bbd3d7568d38b6fe6a818cc0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connection_string_table.html#a1b6bc933bbd3d7568d38b6fe6a818cc0">ConnectionStringTable</a> (<a class="el" href="class_net_connection.html">NetConnection</a> *parent)</td></tr>
<tr class="separator:a1b6bc933bbd3d7568d38b6fe6a818cc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b698c4856b5fa30cd88fd99e95a1a0b" id="r_a6b698c4856b5fa30cd88fd99e95a1a0b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connection_string_table.html#a6b698c4856b5fa30cd88fd99e95a1a0b">confirmStringReceived</a> (<a class="el" href="class_net_string_handle.html">NetStringHandle</a> &amp;string, U32 index)</td></tr>
<tr class="memdesc:a6b698c4856b5fa30cd88fd99e95a1a0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has the specified string been received on the other side?  <br /></td></tr>
<tr class="separator:a6b698c4856b5fa30cd88fd99e95a1a0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ab76f8b7ad0172ca62a7ccd2f4e7493" id="r_a1ab76f8b7ad0172ca62a7ccd2f4e7493"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connection_string_table.html#a1ab76f8b7ad0172ca62a7ccd2f4e7493">checkString</a> (<a class="el" href="class_net_string_handle.html">NetStringHandle</a> &amp;stringTableId, bool *stringOnOtherSide=NULL)</td></tr>
<tr class="separator:a1ab76f8b7ad0172ca62a7ccd2f4e7493"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b25deb172a5d30271594d4ccc88ce2c" id="r_a9b25deb172a5d30271594d4ccc88ce2c"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connection_string_table.html#a9b25deb172a5d30271594d4ccc88ce2c">getNetSendId</a> (<a class="el" href="class_net_string_handle.html">NetStringHandle</a> &amp;stringTableId)</td></tr>
<tr class="separator:a9b25deb172a5d30271594d4ccc88ce2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad75fbfa32f303d2f7ceecd06f72a02d4" id="r_ad75fbfa32f303d2f7ceecd06f72a02d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connection_string_table.html#ad75fbfa32f303d2f7ceecd06f72a02d4">mapString</a> (U32 netId, <a class="el" href="class_net_string_handle.html">NetStringHandle</a> &amp;string)</td></tr>
<tr class="separator:ad75fbfa32f303d2f7ceecd06f72a02d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a67d31b594e01b0b8ab15a02c38c855" id="r_a8a67d31b594e01b0b8ab15a02c38c855"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_net_string_handle.html">NetStringHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connection_string_table.html#a8a67d31b594e01b0b8ab15a02c38c855">lookupString</a> (U32 netId)</td></tr>
<tr class="separator:a8a67d31b594e01b0b8ab15a02c38c855"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Demo functionality</div></td></tr>
<tr class="memitem:a78159c09a6074ca7e380275486a165dd" id="r_a78159c09a6074ca7e380275486a165dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connection_string_table.html#a78159c09a6074ca7e380275486a165dd">readDemoStartBlock</a> (<a class="el" href="class_bit_stream.html">BitStream</a> *stream)</td></tr>
<tr class="separator:a78159c09a6074ca7e380275486a165dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11d968abe8da942fc3f6e13e67b61006" id="r_a11d968abe8da942fc3f6e13e67b61006"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_connection_string_table.html#a11d968abe8da942fc3f6e13e67b61006">writeDemoStartBlock</a> (<a class="el" href="class_resize_bit_stream.html">ResizeBitStream</a> *stream)</td></tr>
<tr class="separator:a11d968abe8da942fc3f6e13e67b61006"><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>Maintain a table of strings which are shared across the network.</p>
<p>This allows us to reference strings in our network streams more efficiently. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a198b8c2c77ea9f9815a181ddeda1c320" name="a198b8c2c77ea9f9815a181ddeda1c320"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a198b8c2c77ea9f9815a181ddeda1c320">&#9670;&#160;</a></span>Constants</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_connection_string_table.html#a198b8c2c77ea9f9815a181ddeda1c320">Constants</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a198b8c2c77ea9f9815a181ddeda1c320aeba3d28abe6bbf1807d64f4d8d1746fd" name="a198b8c2c77ea9f9815a181ddeda1c320aeba3d28abe6bbf1807d64f4d8d1746fd"></a>EntryCount&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a198b8c2c77ea9f9815a181ddeda1c320a99512775751f9700f385f0c8084709ae" name="a198b8c2c77ea9f9815a181ddeda1c320a99512775751f9700f385f0c8084709ae"></a>EntryBitSize&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a198b8c2c77ea9f9815a181ddeda1c320ab34e7ea5ed0693befd653a5b3d5d8b50" name="a198b8c2c77ea9f9815a181ddeda1c320ab34e7ea5ed0693befd653a5b3d5d8b50"></a>InvalidEntryId&#160;</td><td class="fielddoc"></td></tr>
</table>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_connection_string_table.html">ConnectionStringTable</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_net_connection.html">NetConnection</a> *&#160;</td>
          <td class="paramname"><em>parent</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize the connection string table.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">parent</td><td>Connection over which we are maintaining this string table. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1ab76f8b7ad0172ca62a7ccd2f4e7493" name="a1ab76f8b7ad0172ca62a7ccd2f4e7493"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ab76f8b7ad0172ca62a7ccd2f4e7493">&#9670;&#160;</a></span>checkString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U32 checkString </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_net_string_handle.html">NetStringHandle</a> &amp;&#160;</td>
          <td class="paramname"><em>stringTableId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>stringOnOtherSide</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Checks if the global string ID is </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void confirmStringReceived </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_net_string_handle.html">NetStringHandle</a> &amp;&#160;</td>
          <td class="paramname"><em>string</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>index</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">

<p>Has the specified string been received on the other side? </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U32 getNetSendId </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_net_string_handle.html">NetStringHandle</a> &amp;&#160;</td>
          <td class="paramname"><em>stringTableId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>currently valid for this connection and returns the table ID. Sends a string event to the other side if it is not active. It will fill in stringOnOtherSide. Same return value as checkString </p>

</div>
</div>
<a id="a8a67d31b594e01b0b8ab15a02c38c855" name="a8a67d31b594e01b0b8ab15a02c38c855"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a67d31b594e01b0b8ab15a02c38c855">&#9670;&#160;</a></span>lookupString()</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_net_string_handle.html">NetStringHandle</a> lookupString </td>
          <td>(</td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>netId</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>was just sent over the net to the corresponding net ID. </p>
<p>the global string table ID for that string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">netId</td><td>looks up the string ID and returns </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mapString </td>
          <td>(</td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>netId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_net_string_handle.html">NetStringHandle</a> &amp;&#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>but will assert if the string is not valid. Maps a string that </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void readDemoStartBlock </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_bit_stream.html">BitStream</a> *&#160;</td>
          <td class="paramname"><em>stream</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void writeDemoStartBlock </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_resize_bit_stream.html">ResizeBitStream</a> *&#160;</td>
          <td class="paramname"><em>stream</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>network/<b>connectionStringTable.h</b></li>
<li>network/<b>connectionStringTable.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>