PageRenderTime 9ms CodeModel.GetById 2ms app.highlight 4ms RepoModel.GetById 1ms app.codeStats 0ms

/src/middleware/enet/docs/group__global.html

https://bitbucket.org/vivkin/gam3b00bs/
HTML | 124 lines | 118 code | 5 blank | 1 comment | 0 complexity | b4b9b94c64a0d0e9583a46a53e080fa6 MD5 | raw file
  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<title>enet: ENet global functions</title>
  6<link href="tabs.css" rel="stylesheet" type="text/css"/>
  7<link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8</head>
  9<body>
 10<!-- Generated by Doxygen 1.7.1 -->
 11<div class="navigation" id="top">
 12  <div class="tabs">
 13    <ul class="tablist">
 14      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 15      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 16      <li><a href="modules.html"><span>Modules</span></a></li>
 17      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 18      <li><a href="files.html"><span>Files</span></a></li>
 19    </ul>
 20  </div>
 21</div>
 22<div class="header">
 23  <div class="summary">
 24<a href="#func-members">Functions</a>  </div>
 25  <div class="headertitle">
 26<h1>ENet global functions</h1>  </div>
 27</div>
 28<div class="contents">
 29<table class="memberdecls">
 30<tr><td colspan="2"><h2><a name="func-members"></a>
 31Functions</h2></td></tr>
 32<tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#ga67fa85c46a1dc91f968f25fc0637c897">enet_initialize</a> (void)</td></tr>
 33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initializes ENet globally.  <a href="#ga67fa85c46a1dc91f968f25fc0637c897"></a><br/></td></tr>
 34<tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gaef1e7849f3ddde18c6a30f32783c899d">enet_initialize_with_callbacks</a> (ENetVersion version, const <a class="el" href="struct__ENetCallbacks.html">ENetCallbacks</a> *inits)</td></tr>
 35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initializes ENet globally and supplies user-overridden callbacks.  <a href="#gaef1e7849f3ddde18c6a30f32783c899d"></a><br/></td></tr>
 36<tr><td class="memItemLeft" align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gad62cf417e08a2b98d48572a336f7db25">enet_deinitialize</a> (void)</td></tr>
 37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shuts down ENet globally.  <a href="#gad62cf417e08a2b98d48572a336f7db25"></a><br/></td></tr>
 38</table>
 39<hr/><h2>Function Documentation</h2>
 40<a class="anchor" id="gad62cf417e08a2b98d48572a336f7db25"></a><!-- doxytag: member="enet.h::enet_deinitialize" ref="gad62cf417e08a2b98d48572a336f7db25" args="(void)" -->
 41<div class="memitem">
 42<div class="memproto">
 43      <table class="memname">
 44        <tr>
 45          <td class="memname">ENET_API void enet_deinitialize </td>
 46          <td>(</td>
 47          <td class="paramtype">void&nbsp;</td>
 48          <td class="paramname"></td>
 49          <td>&nbsp;)&nbsp;</td>
 50          <td></td>
 51        </tr>
 52      </table>
 53</div>
 54<div class="memdoc">
 55<p>Should be called when a program that has initialized ENet exits. </p>
 56
 57</div>
 58</div>
 59<a class="anchor" id="ga67fa85c46a1dc91f968f25fc0637c897"></a><!-- doxytag: member="enet.h::enet_initialize" ref="ga67fa85c46a1dc91f968f25fc0637c897" args="(void)" -->
 60<div class="memitem">
 61<div class="memproto">
 62      <table class="memname">
 63        <tr>
 64          <td class="memname">ENET_API int enet_initialize </td>
 65          <td>(</td>
 66          <td class="paramtype">void&nbsp;</td>
 67          <td class="paramname"></td>
 68          <td>&nbsp;)&nbsp;</td>
 69          <td></td>
 70        </tr>
 71      </table>
 72</div>
 73<div class="memdoc">
 74<p>Must be called prior to using any functions in ENet. </p>
 75<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, &lt; 0 on failure </dd></dl>
 76
 77<p>Referenced by <a class="el" href="group__global.html#gaef1e7849f3ddde18c6a30f32783c899d">enet_initialize_with_callbacks()</a>.</p>
 78
 79</div>
 80</div>
 81<a class="anchor" id="gaef1e7849f3ddde18c6a30f32783c899d"></a><!-- doxytag: member="enet.h::enet_initialize_with_callbacks" ref="gaef1e7849f3ddde18c6a30f32783c899d" args="(ENetVersion version, const ENetCallbacks *inits)" -->
 82<div class="memitem">
 83<div class="memproto">
 84      <table class="memname">
 85        <tr>
 86          <td class="memname">ENET_API int enet_initialize_with_callbacks </td>
 87          <td>(</td>
 88          <td class="paramtype">ENetVersion&nbsp;</td>
 89          <td class="paramname"> <em>version</em>, </td>
 90        </tr>
 91        <tr>
 92          <td class="paramkey"></td>
 93          <td></td>
 94          <td class="paramtype">const <a class="el" href="struct__ENetCallbacks.html">ENetCallbacks</a> *&nbsp;</td>
 95          <td class="paramname"> <em>inits</em></td><td>&nbsp;</td>
 96        </tr>
 97        <tr>
 98          <td></td>
 99          <td>)</td>
100          <td></td><td></td><td></td>
101        </tr>
102      </table>
103</div>
104<div class="memdoc">
105<p>Must be called prior to using any functions in ENet. Do not use <a class="el" href="group__global.html#ga67fa85c46a1dc91f968f25fc0637c897" title="Initializes ENet globally.">enet_initialize()</a> if you use this variant. Make sure the ENetCallbacks structure is zeroed out so that any additional callbacks added in future versions will be properly ignored.</p>
106<dl><dt><b>Parameters:</b></dt><dd>
107  <table border="0" cellspacing="2" cellpadding="0">
108    <tr><td valign="top"></td><td valign="top"><em>version</em>&nbsp;</td><td>the constant ENET_VERSION should be supplied so ENet knows which version of ENetCallbacks struct to use </td></tr>
109    <tr><td valign="top"></td><td valign="top"><em>inits</em>&nbsp;</td><td>user-overriden callbacks where any NULL callbacks will use ENet's defaults </td></tr>
110  </table>
111  </dd>
112</dl>
113<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, &lt; 0 on failure </dd></dl>
114
115<p>References <a class="el" href="group__global.html#ga67fa85c46a1dc91f968f25fc0637c897">enet_initialize()</a>.</p>
116
117</div>
118</div>
119</div>
120<hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by&nbsp;
121<a href="http://www.doxygen.org/index.html">
122<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
123</body>
124</html>