structRakNet_1_1SocketDescriptor.html 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>RakNet: RakNet::SocketDescriptor Struct Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="jquery.js"></script>
  9. <script type="text/javascript" src="dynsections.js"></script>
  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11. </head>
  12. <body>
  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14. <div id="titlearea">
  15. <table cellspacing="0" cellpadding="0">
  16. <tbody>
  17. <tr style="height: 56px;">
  18. <td style="padding-left: 0.5em;">
  19. <div id="projectname">RakNet
  20. &#160;<span id="projectnumber">4.0</span>
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.2 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. <li><a href="files.html"><span>Files</span></a></li>
  37. </ul>
  38. </div>
  39. <div id="navrow2" class="tabs2">
  40. <ul class="tablist">
  41. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  42. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  43. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  44. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  45. </ul>
  46. </div>
  47. <div id="nav-path" class="navpath">
  48. <ul>
  49. <li class="navelem"><a class="el" href="namespaceRakNet.html">RakNet</a></li><li class="navelem"><a class="el" href="structRakNet_1_1SocketDescriptor.html">SocketDescriptor</a></li> </ul>
  50. </div>
  51. </div><!-- top -->
  52. <div class="header">
  53. <div class="summary">
  54. <a href="#pub-attribs">Public Attributes</a> &#124;
  55. <a href="structRakNet_1_1SocketDescriptor-members.html">List of all members</a> </div>
  56. <div class="headertitle">
  57. <div class="title">RakNet::SocketDescriptor Struct Reference</div> </div>
  58. </div><!--header-->
  59. <div class="contents">
  60. <p>Describes the local socket to use for <a class="el" href="classRakNet_1_1RakPeer.html#a92d493cb617381a6e750f7df6e768927" title="Starts the network threads and opens the listen port.">RakPeer::Startup</a>.
  61. <a href="structRakNet_1_1SocketDescriptor.html#details">More...</a></p>
  62. <p><code>#include &lt;RakNetTypes.h&gt;</code></p>
  63. <table class="memberdecls">
  64. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  65. Public Attributes</h2></td></tr>
  66. <tr class="memitem:a6c1c16e08458b57e09ebb277fdd07c64"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c1c16e08458b57e09ebb277fdd07c64"></a>
  67. unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1SocketDescriptor.html#a6c1c16e08458b57e09ebb277fdd07c64">port</a></td></tr>
  68. <tr class="memdesc:a6c1c16e08458b57e09ebb277fdd07c64"><td class="mdescLeft">&#160;</td><td class="mdescRight">The local port to bind to. Pass 0 to have the OS autoassign a port. <br/></td></tr>
  69. <tr class="separator:a6c1c16e08458b57e09ebb277fdd07c64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:aad9bcadcdd184ccab058d5f960d5f0ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad9bcadcdd184ccab058d5f960d5f0ee"></a>
  71. char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1SocketDescriptor.html#aad9bcadcdd184ccab058d5f960d5f0ee">hostAddress</a> [32]</td></tr>
  72. <tr class="memdesc:aad9bcadcdd184ccab058d5f960d5f0ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">The local network card address to bind to, such as "127.0.0.1". Pass an empty string to use INADDR_ANY. <br/></td></tr>
  73. <tr class="separator:aad9bcadcdd184ccab058d5f960d5f0ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a5d55b4ee9ae18d738ed6066198205a21"><td class="memItemLeft" align="right" valign="top">short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1SocketDescriptor.html#a5d55b4ee9ae18d738ed6066198205a21">socketFamily</a></td></tr>
  75. <tr class="separator:a5d55b4ee9ae18d738ed6066198205a21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a7e793dfc857f28b172abbfa0f1ae4acc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e793dfc857f28b172abbfa0f1ae4acc"></a>
  77. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRakNet_1_1SocketDescriptor.html#a7e793dfc857f28b172abbfa0f1ae4acc">extraSocketOptions</a></td></tr>
  78. <tr class="memdesc:a7e793dfc857f28b172abbfa0f1ae4acc"><td class="mdescLeft">&#160;</td><td class="mdescRight">XBOX only: set IPPROTO_VDP if you want to use VDP. If enabled, this socket does not support broadcast to 255.255.255.255. <br/></td></tr>
  79. <tr class="separator:a7e793dfc857f28b172abbfa0f1ae4acc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. </table>
  81. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  82. <div class="textblock"><p>Describes the local socket to use for <a class="el" href="classRakNet_1_1RakPeer.html#a92d493cb617381a6e750f7df6e768927" title="Starts the network threads and opens the listen port.">RakPeer::Startup</a>. </p>
  83. </div><h2 class="groupheader">Member Data Documentation</h2>
  84. <a class="anchor" id="a5d55b4ee9ae18d738ed6066198205a21"></a>
  85. <div class="memitem">
  86. <div class="memproto">
  87. <table class="memname">
  88. <tr>
  89. <td class="memname">short RakNet::SocketDescriptor::socketFamily</td>
  90. </tr>
  91. </table>
  92. </div><div class="memdoc">
  93. <p>IP version: For IPV4, use AF_INET (default). For IPV6, use AF_INET6. To autoselect, use AF_UNSPEC. IPV6 is the newer internet protocol. Instead of addresses such as natpunch.jenkinssoftware.com, you may have an address such as fe80::7c:31f7:fec4:27de%14. Encoding takes 16 bytes instead of 4, so IPV6 is less efficient for bandwidth. On the positive side, NAT Punchthrough is not needed and should not be used with IPV6 because there are enough addresses that routers do not need to create address mappings. <a class="el" href="classRakNet_1_1RakPeer.html#a92d493cb617381a6e750f7df6e768927" title="Starts the network threads and opens the listen port.">RakPeer::Startup()</a> will fail if this IP version is not supported. </p>
  94. <dl class="section pre"><dt>Precondition</dt><dd>RAKNET_SUPPORT_IPV6 must be set to 1 in RakNetDefines.h for AF_INET6 </dd></dl>
  95. </div>
  96. </div>
  97. <hr/>The documentation for this struct was generated from the following file:<ul>
  98. <li>D:/temp/RakNet_PC/Source/<a class="el" href="RakNetTypes_8h.html">RakNetTypes.h</a></li>
  99. </ul>
  100. </div><!-- contents -->
  101. <!-- start footer part -->
  102. <hr class="footer"/><address class="footer"><small>
  103. Generated on Mon Jun 2 2014 20:10:29 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  104. <img class="footer" src="doxygen.png" alt="doxygen"/>
  105. </a> 1.8.2
  106. </small></address>
  107. </body>
  108. </html>
粤ICP备19079148号