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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>TorqueScript Reference: NetConnection 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="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 style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classNetConnection-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">NetConnection Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Inherits <a class="el" href="classSimGroup.html">SimGroup</a>.</p>

<p>Inherited by <a class="el" href="classGameConnection.html">GameConnection</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3ca3a439befff371232b7e1a2a5d1a85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a3ca3a439befff371232b7e1a2a5d1a85">checkMaxRate</a> ()</td></tr>
<tr class="separator:a3ca3a439befff371232b7e1a2a5d1a85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b22ac32275d0e68252d525ef6c0158a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a4b22ac32275d0e68252d525ef6c0158a">connect</a> (remoteAddress)</td></tr>
<tr class="separator:a4b22ac32275d0e68252d525ef6c0158a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a178eb5c048b723732d03439e86b0a88c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a178eb5c048b723732d03439e86b0a88c">connectLocal</a> ()</td></tr>
<tr class="separator:a178eb5c048b723732d03439e86b0a88c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a927251e54364b4e3d64355a785b03013"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a927251e54364b4e3d64355a785b03013">getAddress</a> ()</td></tr>
<tr class="separator:a927251e54364b4e3d64355a785b03013"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a222b51680a35161072c044ce1881803e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a222b51680a35161072c044ce1881803e">getGhostID</a> (S32 realID)</td></tr>
<tr class="separator:a222b51680a35161072c044ce1881803e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af590a134d615bd768f003171e4c19afa"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#af590a134d615bd768f003171e4c19afa">getGhostsActive</a> ()</td></tr>
<tr class="separator:af590a134d615bd768f003171e4c19afa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae550d23c0f9088a48aba2e37e572702"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#aae550d23c0f9088a48aba2e37e572702">getPacketLoss</a> ()</td></tr>
<tr class="separator:aae550d23c0f9088a48aba2e37e572702"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae8c640eb6d823e52672cb1e4f5bf1ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#aae8c640eb6d823e52672cb1e4f5bf1ba">getPing</a> ()</td></tr>
<tr class="separator:aae8c640eb6d823e52672cb1e4f5bf1ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa38d848b8d324815dadb27e71e0c7dad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#aa38d848b8d324815dadb27e71e0c7dad">resolveGhostID</a> (S32 ghostID)</td></tr>
<tr class="separator:aa38d848b8d324815dadb27e71e0c7dad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a698f7548d225ee35a783ff510b8ee7db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a698f7548d225ee35a783ff510b8ee7db">resolveObjectFromGhostIndex</a> (S32 ghostIdx)</td></tr>
<tr class="separator:a698f7548d225ee35a783ff510b8ee7db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad796615b5ffc4d20f4e48e3421ff3c47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#ad796615b5ffc4d20f4e48e3421ff3c47">setSimulatedNetParams</a> (packetLoss, delay)</td></tr>
<tr class="separator:ad796615b5ffc4d20f4e48e3421ff3c47"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3ca3a439befff371232b7e1a2a5d1a85"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void checkMaxRate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the checkMaxRate method to retrieve the current maximum packet rate for this connection. The period may not neccesarily be one second. To adjust packet rates, see the preference variables above </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer value representing the maximum number of packets that can be transmitted by this connection per transmission period. </dd></dl>

</div>
</div>
<a class="anchor" id="a4b22ac32275d0e68252d525ef6c0158a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void connect </td>
          <td>(</td>
          <td class="paramtype">remoteAddress&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the connect method to request a connection to a remote server at the address remoteAddress. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">remoteAddress</td><td>A string containing an address of the form: A.B.C.D:Port, where A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a178eb5c048b723732d03439e86b0a88c">connectLocal</a>, <a class="el" href="classNetConnection.html#a927251e54364b4e3d64355a785b03013">getAddress</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a178eb5c048b723732d03439e86b0a88c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> connectLocal </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the connectLocal method to connect the current client-side connection to a local <a class="el" href="classNetConnection.html">NetConnection</a>, that is to create an internal connection from this client to the internal server. This is accomplished through the use of a back door mechanism and has an extremely high bandwidth. </p>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a4b22ac32275d0e68252d525ef6c0158a">connect</a>, <a class="el" href="classNetConnection.html#a927251e54364b4e3d64355a785b03013">getAddress</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a927251e54364b4e3d64355a785b03013"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getAddress </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getAddress method to get the address and port that this <a class="el" href="classNetConnection.html">NetConnection</a> is currently attached to. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns the address and port that this <a class="el" href="classNetConnection.html">NetConnection</a> is currently attached to, where the addres will be of the form: A.B.C.D:Port. A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536. If the connection is local, the string 'local' will be returned. If a this <a class="el" href="classNetConnection.html">NetConnection</a> is not currently connected the method will return a NULL string. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a4b22ac32275d0e68252d525ef6c0158a">connect</a>, <a class="el" href="classNetConnection.html#a178eb5c048b723732d03439e86b0a88c">connectLocal</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a222b51680a35161072c044ce1881803e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getGhostID </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>realID</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Convert a real id to the ghost id for this connection. </p>
<dl class="section return"><dt>Returns</dt><dd>The ID as an integer </dd></dl>

</div>
</div>
<a class="anchor" id="af590a134d615bd768f003171e4c19afa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">S32 getGhostsActive </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getGhostsActive method to determine how many ghosts are active on a particular connection. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer value between 0 and inf, specifying how many objects are being ghosted to a client on the other side of a specific connection </dd></dl>

</div>
</div>
<a class="anchor" id="aae550d23c0f9088a48aba2e37e572702"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getPacketLoss </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getPacketLoss method to determine the current packetLoss count for this connection. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer value between 0 and inf, indicating the number of packets that have been lost to date on this net connection. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#aae8c640eb6d823e52672cb1e4f5bf1ba">getPing</a> </dd></dl>

</div>
</div>
<a class="anchor" id="aae8c640eb6d823e52672cb1e4f5bf1ba"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getPing </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getPing method to determine the round-trip travel time from this connection to the agent on the other end and back again. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer value representing the total time in milliseconds it takes for a ping request to travel to the agent on the other end of a connection and back to this agent. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#aae550d23c0f9088a48aba2e37e572702">getPacketLoss</a> </dd></dl>

</div>
</div>
<a class="anchor" id="aa38d848b8d324815dadb27e71e0c7dad"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> resolveGhostID </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>ghostID</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Convert a ghost id from this connection to a real id. </p>
<dl class="section return"><dt>Returns</dt><dd>The ID as an integer </dd></dl>

</div>
</div>
<a class="anchor" id="a698f7548d225ee35a783ff510b8ee7db"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> resolveObjectFromGhostIndex </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>ghostIdx</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Convert a ghost index from this connection to a real id. </p>
<dl class="section return"><dt>Returns</dt><dd>The ID as an integer </dd></dl>

</div>
</div>
<a class="anchor" id="ad796615b5ffc4d20f4e48e3421ff3c47"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setSimulatedNetParams </td>
          <td>(</td>
          <td class="paramtype">packetLoss&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">delay&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setSimulatedNetParams method to force a connection to experience a certain degree of packet-loss and/or latency. This is a debug feature to allow us to see how a distributed game will behave in the face of poor connection quality. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">packetLoss</td><td>A floating-point value between 0.0 (0%) and 1.0 (100%) dictating the percentage of packets to be artificially lost. </td></tr>
    <tr><td class="paramname">delay</td><td>An integer value specifying the number of milliseconds to insert into transmission latencies. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#aae550d23c0f9088a48aba2e37e572702">getPacketLoss</a>, <a class="el" href="classNetConnection.html#aae8c640eb6d823e52672cb1e4f5bf1ba">getPing</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>