File: protocol_8h.html

package info (click to toggle)
enet 1.3.3-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 2,448 kB
  • sloc: sh: 10,131; ansic: 4,364; makefile: 34
file content (158 lines) | stat: -rw-r--r-- 14,226 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
<!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"/>
<title>enet: protocol.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Defines</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<h1>protocol.h File Reference</h1>  </div>
</div>
<div class="contents">

<p>ENet protocol.  
<a href="#_details">More...</a></p>
<code>#include &quot;<a class="el" href="types_8h_source.html">enet/types.h</a>&quot;</code><br/>

<p><a href="protocol_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolHeader.html">_ENetProtocolHeader</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolCommandHeader.html">_ENetProtocolCommandHeader</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolAcknowledge.html">_ENetProtocolAcknowledge</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolConnect.html">_ENetProtocolConnect</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolVerifyConnect.html">_ENetProtocolVerifyConnect</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolBandwidthLimit.html">_ENetProtocolBandwidthLimit</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolThrottleConfigure.html">_ENetProtocolThrottleConfigure</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolDisconnect.html">_ENetProtocolDisconnect</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolPing.html">_ENetProtocolPing</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolSendReliable.html">_ENetProtocolSendReliable</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolSendUnreliable.html">_ENetProtocolSendUnreliable</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolSendUnsequenced.html">_ENetProtocolSendUnsequenced</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__ENetProtocolSendFragment.html">_ENetProtocolSendFragment</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">union &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="union__ENetProtocol.html">_ENetProtocol</a></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05a936aa528d618375ed1e7d19a161c5"></a><!-- doxytag: member="protocol.h::ENetProtocolCommand" ref="a05a936aa528d618375ed1e7d19a161c5" args="" -->
typedef enum _ENetProtocolCommand&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolCommand</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af14766e694ee036cce548b3c16123541"></a><!-- doxytag: member="protocol.h::ENetProtocolFlag" ref="af14766e694ee036cce548b3c16123541" args="" -->
typedef enum _ENetProtocolFlag&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolFlag</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad507ebf1b925e294e3a2f175cbcd7d9"></a><!-- doxytag: member="protocol.h::ENetProtocolHeader" ref="aad507ebf1b925e294e3a2f175cbcd7d9" args="" -->
typedef struct <a class="el" href="struct__ENetProtocolHeader.html">_ENetProtocolHeader</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolHeader</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e3618482e85596ba9403ee09e9c1020"></a><!-- doxytag: member="protocol.h::ENetProtocolCommandHeader" ref="a9e3618482e85596ba9403ee09e9c1020" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolCommandHeader.html">_ENetProtocolCommandHeader</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolCommandHeader</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d9fbdba6e50c3d5fad0c4b6cf6f6c90"></a><!-- doxytag: member="protocol.h::ENetProtocolAcknowledge" ref="a7d9fbdba6e50c3d5fad0c4b6cf6f6c90" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolAcknowledge.html">_ENetProtocolAcknowledge</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolAcknowledge</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7891380ae5c2590c92690c7521ece09c"></a><!-- doxytag: member="protocol.h::ENetProtocolConnect" ref="a7891380ae5c2590c92690c7521ece09c" args="" -->
typedef struct <a class="el" href="struct__ENetProtocolConnect.html">_ENetProtocolConnect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolConnect</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1aa28002e4974f1b6c22c24014e5fe35"></a><!-- doxytag: member="protocol.h::ENetProtocolVerifyConnect" ref="a1aa28002e4974f1b6c22c24014e5fe35" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolVerifyConnect.html">_ENetProtocolVerifyConnect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolVerifyConnect</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46b110845b0c0b748aa953f1cb4fe9a8"></a><!-- doxytag: member="protocol.h::ENetProtocolBandwidthLimit" ref="a46b110845b0c0b748aa953f1cb4fe9a8" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolBandwidthLimit.html">_ENetProtocolBandwidthLimit</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolBandwidthLimit</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a853de3af91cf6cd5391c29ae512a5ecd"></a><!-- doxytag: member="protocol.h::ENetProtocolThrottleConfigure" ref="a853de3af91cf6cd5391c29ae512a5ecd" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolThrottleConfigure.html">_ENetProtocolThrottleConfigure</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolThrottleConfigure</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a795e6ba7faf70e597a9c7ac883250d85"></a><!-- doxytag: member="protocol.h::ENetProtocolDisconnect" ref="a795e6ba7faf70e597a9c7ac883250d85" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolDisconnect.html">_ENetProtocolDisconnect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolDisconnect</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b5b74b8cd1b5afb02646354ed7d0220"></a><!-- doxytag: member="protocol.h::ENetProtocolPing" ref="a0b5b74b8cd1b5afb02646354ed7d0220" args="" -->
typedef struct <a class="el" href="struct__ENetProtocolPing.html">_ENetProtocolPing</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolPing</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ad19c5fc39268a2b5e33f9714abdb8f"></a><!-- doxytag: member="protocol.h::ENetProtocolSendReliable" ref="a5ad19c5fc39268a2b5e33f9714abdb8f" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolSendReliable.html">_ENetProtocolSendReliable</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendReliable</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afef850d31e169ddf1dd02c430db82ef6"></a><!-- doxytag: member="protocol.h::ENetProtocolSendUnreliable" ref="afef850d31e169ddf1dd02c430db82ef6" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolSendUnreliable.html">_ENetProtocolSendUnreliable</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendUnreliable</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad63e61158b89a5d160de36986bba52b2"></a><!-- doxytag: member="protocol.h::ENetProtocolSendUnsequenced" ref="ad63e61158b89a5d160de36986bba52b2" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolSendUnsequenced.html">_ENetProtocolSendUnsequenced</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendUnsequenced</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e419692dc01a5627967ff1703121ef7"></a><!-- doxytag: member="protocol.h::ENetProtocolSendFragment" ref="a4e419692dc01a5627967ff1703121ef7" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="struct__ENetProtocolSendFragment.html">_ENetProtocolSendFragment</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocolSendFragment</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afceae4a4825b2d50174babcc224c5c93"></a><!-- doxytag: member="protocol.h::ENetProtocol" ref="afceae4a4825b2d50174babcc224c5c93" args="" -->
typedef union <a class="el" href="union__ENetProtocol.html">_ENetProtocol</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENetProtocol</b></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br/>
&nbsp;&nbsp;<b>ENET_PROTOCOL_MINIMUM_MTU</b> =  576, 
<b>ENET_PROTOCOL_MAXIMUM_MTU</b> =  4096, 
<b>ENET_PROTOCOL_MAXIMUM_PACKET_COMMANDS</b> =  32, 
<b>ENET_PROTOCOL_MINIMUM_WINDOW_SIZE</b> =  4096, 
<br/>
&nbsp;&nbsp;<b>ENET_PROTOCOL_MAXIMUM_WINDOW_SIZE</b> =  32768, 
<b>ENET_PROTOCOL_MINIMUM_CHANNEL_COUNT</b> =  1, 
<b>ENET_PROTOCOL_MAXIMUM_CHANNEL_COUNT</b> =  255, 
<b>ENET_PROTOCOL_MAXIMUM_PEER_ID</b> =  0xFFF
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetProtocolCommand</b> { <br/>
&nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_NONE</b> =  0, 
<b>ENET_PROTOCOL_COMMAND_ACKNOWLEDGE</b> =  1, 
<b>ENET_PROTOCOL_COMMAND_CONNECT</b> =  2, 
<b>ENET_PROTOCOL_COMMAND_VERIFY_CONNECT</b> =  3, 
<br/>
&nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_DISCONNECT</b> =  4, 
<b>ENET_PROTOCOL_COMMAND_PING</b> =  5, 
<b>ENET_PROTOCOL_COMMAND_SEND_RELIABLE</b> =  6, 
<b>ENET_PROTOCOL_COMMAND_SEND_UNRELIABLE</b> =  7, 
<br/>
&nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_SEND_FRAGMENT</b> =  8, 
<b>ENET_PROTOCOL_COMMAND_SEND_UNSEQUENCED</b> =  9, 
<b>ENET_PROTOCOL_COMMAND_BANDWIDTH_LIMIT</b> =  10, 
<b>ENET_PROTOCOL_COMMAND_THROTTLE_CONFIGURE</b> =  11, 
<br/>
&nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_SEND_UNRELIABLE_FRAGMENT</b> =  12, 
<b>ENET_PROTOCOL_COMMAND_COUNT</b> =  13, 
<b>ENET_PROTOCOL_COMMAND_MASK</b> =  0x0F
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>_ENetProtocolFlag</b> { <br/>
&nbsp;&nbsp;<b>ENET_PROTOCOL_COMMAND_FLAG_ACKNOWLEDGE</b> =  (1 &lt;&lt; 7), 
<b>ENET_PROTOCOL_COMMAND_FLAG_UNSEQUENCED</b> =  (1 &lt;&lt; 6), 
<b>ENET_PROTOCOL_HEADER_FLAG_COMPRESSED</b> =  (1 &lt;&lt; 14), 
<b>ENET_PROTOCOL_HEADER_FLAG_SENT_TIME</b> =  (1 &lt;&lt; 15), 
<br/>
&nbsp;&nbsp;<b>ENET_PROTOCOL_HEADER_FLAG_MASK</b> =  ENET_PROTOCOL_HEADER_FLAG_COMPRESSED | ENET_PROTOCOL_HEADER_FLAG_SENT_TIME, 
<b>ENET_PROTOCOL_HEADER_SESSION_MASK</b> =  (3 &lt;&lt; 12), 
<b>ENET_PROTOCOL_HEADER_SESSION_SHIFT</b> =  12
<br/>
 }</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue May 31 2011 03:26:47 for enet by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>