Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/enet-1.1/docs/html/group__global.html @ 13

Last change on this file since 13 was 13, checked in by landauf, 16 years ago

added enet
File size: 5.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>enet: ENet global functions</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.1 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
13    <li><a href="files.html"><span>Files</span></a></li>
14    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15  </ul></div>
16<h1>ENet global functions</h1>
17<p>
18<table border="0" cellpadding="0" cellspacing="0">
19<tr><td></td></tr>
20<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
21<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#g67fa85c46a1dc91f968f25fc0637c897">enet_initialize</a> (void)</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initializes ENet globally.  <a href="#g67fa85c46a1dc91f968f25fc0637c897"></a><br></td></tr>
24<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gef1e7849f3ddde18c6a30f32783c899d">enet_initialize_with_callbacks</a> (ENetVersion version, const ENetCallbacks *inits)</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initializes ENet globally and supplies user-overridden callbacks.  <a href="#gef1e7849f3ddde18c6a30f32783c899d"></a><br></td></tr>
27<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gd62cf417e08a2b98d48572a336f7db25">enet_deinitialize</a> (void)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shuts down ENet globally.  <a href="#gd62cf417e08a2b98d48572a336f7db25"></a><br></td></tr>
30</table>
31<hr><h2>Function Documentation</h2>
32<a class="anchor" name="gd62cf417e08a2b98d48572a336f7db25"></a><!-- doxytag: member="enet.h::enet_deinitialize" ref="gd62cf417e08a2b98d48572a336f7db25" args="(void)" -->
33<div class="memitem">
34<div class="memproto">
35      <table class="memname">
36        <tr>
37          <td class="memname">ENET_API void enet_deinitialize           </td>
38          <td>(</td>
39          <td class="paramtype">void&nbsp;</td>
40          <td class="paramname">          </td>
41          <td>&nbsp;)&nbsp;</td>
42          <td width="100%"></td>
43        </tr>
44      </table>
45</div>
46<div class="memdoc">
47
48<p>
49Should be called when a program that has initialized ENet exits.
50</div>
51</div><p>
52<a class="anchor" name="g67fa85c46a1dc91f968f25fc0637c897"></a><!-- doxytag: member="enet.h::enet_initialize" ref="g67fa85c46a1dc91f968f25fc0637c897" args="(void)" -->
53<div class="memitem">
54<div class="memproto">
55      <table class="memname">
56        <tr>
57          <td class="memname">ENET_API int enet_initialize           </td>
58          <td>(</td>
59          <td class="paramtype">void&nbsp;</td>
60          <td class="paramname">          </td>
61          <td>&nbsp;)&nbsp;</td>
62          <td width="100%"></td>
63        </tr>
64      </table>
65</div>
66<div class="memdoc">
67
68<p>
69Must be called prior to using any functions in ENet. <dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, &lt; 0 on failure </dd></dl>
70
71</div>
72</div><p>
73<a class="anchor" name="gef1e7849f3ddde18c6a30f32783c899d"></a><!-- doxytag: member="enet.h::enet_initialize_with_callbacks" ref="gef1e7849f3ddde18c6a30f32783c899d" args="(ENetVersion version, const ENetCallbacks *inits)" -->
74<div class="memitem">
75<div class="memproto">
76      <table class="memname">
77        <tr>
78          <td class="memname">ENET_API int enet_initialize_with_callbacks           </td>
79          <td>(</td>
80          <td class="paramtype">ENetVersion&nbsp;</td>
81          <td class="paramname"> <em>version</em>, </td>
82        </tr>
83        <tr>
84          <td class="paramkey"></td>
85          <td></td>
86          <td class="paramtype">const ENetCallbacks *&nbsp;</td>
87          <td class="paramname"> <em>inits</em></td><td>&nbsp;</td>
88        </tr>
89        <tr>
90          <td></td>
91          <td>)</td>
92          <td></td><td></td><td width="100%"></td>
93        </tr>
94      </table>
95</div>
96<div class="memdoc">
97
98<p>
99Must be called prior to using any functions in ENet. Do not use <a class="el" href="group__global.html#g67fa85c46a1dc91f968f25fc0637c897">enet_initialize()</a> if you use this variant.<p>
100<dl compact><dt><b>Parameters:</b></dt><dd>
101  <table border="0" cellspacing="2" cellpadding="0">
102    <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>
103    <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>
104  </table>
105</dl>
106<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, &lt; 0 on failure </dd></dl>
107
108</div>
109</div><p>
110<hr size="1"><address style="align: right;"><small>Generated on Wed Jun 6 14:33:50 2007 for enet by&nbsp;
111<a href="http://www.doxygen.org/index.html">
112<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
113</body>
114</html>
Note: See TracBrowser for help on using the repository browser.