TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
							<!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: PlatformNetState Namespace 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="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">PlatformNetState Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab193e7635bf3774e0ee80858599678ca" id="r_ab193e7635bf3774e0ee80858599678ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_net.html#a2c3e4bb40f36b262a5214e2da2bca9c5">Net::Error</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_platform_net_state.html#ab193e7635bf3774e0ee80858599678ca">getLastError</a> ()</td></tr>
<tr class="separator:ab193e7635bf3774e0ee80858599678ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31cccea1c3b16e8cace265d8d4b7c3df" id="r_a31cccea1c3b16e8cace265d8d4b7c3df"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_platform_net_state.html#a31cccea1c3b16e8cace265d8d4b7c3df">getDefaultGameProtocol</a> ()</td></tr>
<tr class="separator:a31cccea1c3b16e8cace265d8d4b7c3df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac56a24ba7254cb5a334ce76879fd4da1" id="r_ac56a24ba7254cb5a334ce76879fd4da1"><td class="memItemLeft" align="right" valign="top">struct addrinfo *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_platform_net_state.html#ac56a24ba7254cb5a334ce76879fd4da1">pickAddressByProtocol</a> (struct addrinfo *addr, int protocol)</td></tr>
<tr class="separator:ac56a24ba7254cb5a334ce76879fd4da1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a621515aeb0ac1180e92773daa8bff887" id="r_a621515aeb0ac1180e92773daa8bff887"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_platform_net_state.html#a621515aeb0ac1180e92773daa8bff887">extractAddressParts</a> (const char *addressString, char outAddress[256], int &amp;outPort, int &amp;outFamily)</td></tr>
<tr class="memdesc:a621515aeb0ac1180e92773daa8bff887"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extracts core address parts from an address string. Returns false if it's malformed.  <br /></td></tr>
<tr class="separator:a621515aeb0ac1180e92773daa8bff887"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa37f1a113c32097aa34ff26666594b00" id="r_aa37f1a113c32097aa34ff26666594b00"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_net.html#a2c3e4bb40f36b262a5214e2da2bca9c5">Net::Error</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_platform_net_state.html#aa37f1a113c32097aa34ff26666594b00">getSocketAddress</a> (SOCKET socketFd, int requiredFamily, <a class="el" href="struct_net_address.html">NetAddress</a> *outAddress)</td></tr>
<tr class="separator:aa37f1a113c32097aa34ff26666594b00"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a621515aeb0ac1180e92773daa8bff887" name="a621515aeb0ac1180e92773daa8bff887"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a621515aeb0ac1180e92773daa8bff887">&#9670;&#160;</a></span>extractAddressParts()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool extractAddressParts </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>addressString</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname"><em>outAddress</em>[256], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&#160;</td>
          <td class="paramname"><em>outPort</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&#160;</td>
          <td class="paramname"><em>outFamily</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Extracts core address parts from an address string. Returns false if it's malformed. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">S32 getDefaultGameProtocol </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_net.html#a2c3e4bb40f36b262a5214e2da2bca9c5">Net::Error</a> getLastError </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_net.html#a2c3e4bb40f36b262a5214e2da2bca9c5">Net::Error</a> getSocketAddress </td>
          <td>(</td>
          <td class="paramtype">SOCKET&#160;</td>
          <td class="paramname"><em>socketFd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>requiredFamily</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_net_address.html">NetAddress</a> *&#160;</td>
          <td class="paramname"><em>outAddress</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct addrinfo * pickAddressByProtocol </td>
          <td>(</td>
          <td class="paramtype">struct addrinfo *&#160;</td>
          <td class="paramname"><em>addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>protocol</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
</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>