| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351 |
- <!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: NetSocket Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">Torque2D Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#pub-static-attribs">Static Public Attributes</a> |
- <a href="#pro-attribs">Protected Attributes</a> |
- <a href="class_net_socket-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">NetSocket Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <platformNet.h></code></p>
- <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:a2615bf5c36b8ab5d8547c1d10a38c17b" id="r_a2615bf5c36b8ab5d8547c1d10a38c17b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a2615bf5c36b8ab5d8547c1d10a38c17b">NetSocket</a> ()</td></tr>
- <tr class="separator:a2615bf5c36b8ab5d8547c1d10a38c17b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a696bcb47153951eb246b09a501530ad7" id="r_a696bcb47153951eb246b09a501530ad7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a696bcb47153951eb246b09a501530ad7">setHandle</a> (S32 handleId)</td></tr>
- <tr class="separator:a696bcb47153951eb246b09a501530ad7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf6699fa447cd5467646f9768fa11d8d" id="r_aaf6699fa447cd5467646f9768fa11d8d"><td class="memItemLeft" align="right" valign="top">S32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#aaf6699fa447cd5467646f9768fa11d8d">getHandle</a> () const</td></tr>
- <tr class="separator:aaf6699fa447cd5467646f9768fa11d8d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a13fe8fb74956089fb45332fa8b89f270" id="r_a13fe8fb74956089fb45332fa8b89f270"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a13fe8fb74956089fb45332fa8b89f270">getHash</a> () const</td></tr>
- <tr class="separator:a13fe8fb74956089fb45332fa8b89f270"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2b7fddd6932bec6dff9a447094e8d75b" id="r_a2b7fddd6932bec6dff9a447094e8d75b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a2b7fddd6932bec6dff9a447094e8d75b">operator==</a> (const <a class="el" href="class_net_socket.html">NetSocket</a> &other) const</td></tr>
- <tr class="separator:a2b7fddd6932bec6dff9a447094e8d75b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aee134ffe92ce78a16673d98a9f1c9bee" id="r_aee134ffe92ce78a16673d98a9f1c9bee"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#aee134ffe92ce78a16673d98a9f1c9bee">operator!=</a> (const <a class="el" href="class_net_socket.html">NetSocket</a> &other) const</td></tr>
- <tr class="separator:aee134ffe92ce78a16673d98a9f1c9bee"><td class="memSeparator" colspan="2"> </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:ad0b85d1f4d65b2c34b3c48647b1973d0" id="r_ad0b85d1f4d65b2c34b3c48647b1973d0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_net_socket.html">NetSocket</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#ad0b85d1f4d65b2c34b3c48647b1973d0">fromHandle</a> (S32 handleId)</td></tr>
- <tr class="separator:ad0b85d1f4d65b2c34b3c48647b1973d0"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
- Static Public Attributes</h2></td></tr>
- <tr class="memitem:a484e8ef86ca208fab5bbb9419dd90552" id="r_a484e8ef86ca208fab5bbb9419dd90552"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_net_socket.html">NetSocket</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#a484e8ef86ca208fab5bbb9419dd90552">INVALID</a> = <a class="el" href="class_net_socket.html#ad0b85d1f4d65b2c34b3c48647b1973d0">NetSocket::fromHandle</a>(-1)</td></tr>
- <tr class="separator:a484e8ef86ca208fab5bbb9419dd90552"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
- Protected Attributes</h2></td></tr>
- <tr class="memitem:ac566232025e23626d9583c9779102f07" id="r_ac566232025e23626d9583c9779102f07"><td class="memItemLeft" align="right" valign="top">S32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_net_socket.html#ac566232025e23626d9583c9779102f07">mHandle</a></td></tr>
- <tr class="separator:ac566232025e23626d9583c9779102f07"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a2615bf5c36b8ab5d8547c1d10a38c17b" name="a2615bf5c36b8ab5d8547c1d10a38c17b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2615bf5c36b8ab5d8547c1d10a38c17b">◆ </a></span>NetSocket()</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_socket.html">NetSocket</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">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="ad0b85d1f4d65b2c34b3c48647b1973d0" name="ad0b85d1f4d65b2c34b3c48647b1973d0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad0b85d1f4d65b2c34b3c48647b1973d0">◆ </a></span>fromHandle()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="class_net_socket.html">NetSocket</a> fromHandle </td>
- <td>(</td>
- <td class="paramtype">S32 </td>
- <td class="paramname"><em>handleId</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aaf6699fa447cd5467646f9768fa11d8d" name="aaf6699fa447cd5467646f9768fa11d8d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aaf6699fa447cd5467646f9768fa11d8d">◆ </a></span>getHandle()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">S32 getHandle </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">
- </div>
- </div>
- <a id="a13fe8fb74956089fb45332fa8b89f270" name="a13fe8fb74956089fb45332fa8b89f270"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a13fe8fb74956089fb45332fa8b89f270">◆ </a></span>getHash()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 getHash </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">
- </div>
- </div>
- <a id="aee134ffe92ce78a16673d98a9f1c9bee" name="aee134ffe92ce78a16673d98a9f1c9bee"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aee134ffe92ce78a16673d98a9f1c9bee">◆ </a></span>operator!=()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool operator!= </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_net_socket.html">NetSocket</a> & </td>
- <td class="paramname"><em>other</em></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">
- </div>
- </div>
- <a id="a2b7fddd6932bec6dff9a447094e8d75b" name="a2b7fddd6932bec6dff9a447094e8d75b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2b7fddd6932bec6dff9a447094e8d75b">◆ </a></span>operator==()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool operator== </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_net_socket.html">NetSocket</a> & </td>
- <td class="paramname"><em>other</em></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">
- </div>
- </div>
- <a id="a696bcb47153951eb246b09a501530ad7" name="a696bcb47153951eb246b09a501530ad7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a696bcb47153951eb246b09a501530ad7">◆ </a></span>setHandle()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setHandle </td>
- <td>(</td>
- <td class="paramtype">S32 </td>
- <td class="paramname"><em>handleId</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>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="a484e8ef86ca208fab5bbb9419dd90552" name="a484e8ef86ca208fab5bbb9419dd90552"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a484e8ef86ca208fab5bbb9419dd90552">◆ </a></span>INVALID</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_socket.html">NetSocket</a> INVALID = <a class="el" href="class_net_socket.html#ad0b85d1f4d65b2c34b3c48647b1973d0">NetSocket::fromHandle</a>(-1)</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ac566232025e23626d9583c9779102f07" name="ac566232025e23626d9583c9779102f07"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac566232025e23626d9583c9779102f07">◆ </a></span>mHandle</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">S32 mHandle</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>platform/<b>platformNet.h</b></li>
- <li>platform/<b>platformNet.cpp</b></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|