PageRenderTime 12ms CodeModel.GetById 2ms app.highlight 7ms RepoModel.GetById 1ms app.codeStats 0ms

/src/middleware/enet/docs/peer_8c.html

https://bitbucket.org/vivkin/gam3b00bs/
HTML | 87 lines | 85 code | 1 blank | 1 comment | 0 complexity | c05bd8eecc82e7da04db4195c109e58f 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: peer.c File Reference</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 class="current"><a href="files.html"><span>Files</span></a></li>
19    </ul>
20  </div>
21  <div class="tabs2">
22    <ul class="tablist">
23      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
24      <li><a href="globals.html"><span>Globals</span></a></li>
25    </ul>
26  </div>
27</div>
28<div class="header">
29  <div class="summary">
30<a href="#define-members">Defines</a> &#124;
31<a href="#func-members">Functions</a>  </div>
32  <div class="headertitle">
33<h1>peer.c File Reference</h1>  </div>
34</div>
35<div class="contents">
36
37<p>ENet peer management functions.  
38<a href="#_details">More...</a></p>
39<code>#include &lt;string.h&gt;</code><br/>
40<code>#include &quot;<a class="el" href="enet_8h_source.html">enet/enet.h</a>&quot;</code><br/>
41<table class="memberdecls">
42<tr><td colspan="2"><h2><a name="define-members"></a>
43Defines</h2></td></tr>
44<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0dc3ac14ddf12c81cb53d3e662ad277f"></a><!-- doxytag: member="peer.c::ENET_BUILDING_LIB" ref="a0dc3ac14ddf12c81cb53d3e662ad277f" args="" -->
45#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ENET_BUILDING_LIB</b>&nbsp;&nbsp;&nbsp;1</td></tr>
46<tr><td colspan="2"><h2><a name="func-members"></a>
47Functions</h2></td></tr>
48<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#gab35807c848b6c88af12ce8476dffbc84">enet_peer_throttle_configure</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> interval, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> acceleration, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> deceleration)</td></tr>
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Configures throttle parameter for a peer.  <a href="group__peer.html#gab35807c848b6c88af12ce8476dffbc84"></a><br/></td></tr>
50<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga52c5c6b1bbd807466298b2d7ed12fdd6"></a><!-- doxytag: member="peer.c::enet_peer_throttle" ref="ga52c5c6b1bbd807466298b2d7ed12fdd6" args="(ENetPeer *peer, enet_uint32 rtt)" -->
51int&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_throttle</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> rtt)</td></tr>
52<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#gaf082a0ae58d9c435bed75c7325cf7290">enet_peer_send</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> channelID, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *packet)</td></tr>
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Queues a packet to be sent.  <a href="group__peer.html#gaf082a0ae58d9c435bed75c7325cf7290"></a><br/></td></tr>
54<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__ENetPacket.html">ENetPacket</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga6493c7807f5381395305c9c48913a46c">enet_peer_receive</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="types_8h.html#a34ce80c65abc6389fe0121a83d757f07">enet_uint8</a> *channelID)</td></tr>
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to dequeue any incoming queued packet.  <a href="group__peer.html#ga6493c7807f5381395305c9c48913a46c"></a><br/></td></tr>
56<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9a8da1e258f10bbef173abd598534f09"></a><!-- doxytag: member="peer.c::enet_peer_reset_queues" ref="ga9a8da1e258f10bbef173abd598534f09" args="(ENetPeer *peer)" -->
57void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_reset_queues</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer)</td></tr>
58<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga9444dfff9574a7d21dbbdd34385a7d4d">enet_peer_reset</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer)</td></tr>
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Forcefully disconnects a peer.  <a href="group__peer.html#ga9444dfff9574a7d21dbbdd34385a7d4d"></a><br/></td></tr>
60<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga5c0708ddaf340aa42e7754a91ce456b6">enet_peer_ping</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer)</td></tr>
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends a ping request to a peer.  <a href="group__peer.html#ga5c0708ddaf340aa42e7754a91ce456b6"></a><br/></td></tr>
62<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga636cc45f52461b567d6daffe4ab8f4e9">enet_peer_disconnect_now</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> data)</td></tr>
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Force an immediate disconnection from a peer.  <a href="group__peer.html#ga636cc45f52461b567d6daffe4ab8f4e9"></a><br/></td></tr>
64<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga0e807704b6ecace5004c2cdcfbf813c2">enet_peer_disconnect</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> data)</td></tr>
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request a disconnection from a peer.  <a href="group__peer.html#ga0e807704b6ecace5004c2cdcfbf813c2"></a><br/></td></tr>
66<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__peer.html#ga759270d8cccec70f76274e93b49e5ac5">enet_peer_disconnect_later</a> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> data)</td></tr>
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request a disconnection from a peer, but only after all queued outgoing packets are sent.  <a href="group__peer.html#ga759270d8cccec70f76274e93b49e5ac5"></a><br/></td></tr>
68<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6f8ab6421d3455b7b12b14f477ea83aa"></a><!-- doxytag: member="peer.c::enet_peer_queue_acknowledgement" ref="ga6f8ab6421d3455b7b12b14f477ea83aa" args="(ENetPeer *peer, const ENetProtocol *command, enet_uint16 sentTime)" -->
69<a class="el" href="struct__ENetAcknowledgement.html">ENetAcknowledgement</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_queue_acknowledgement</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, const <a class="el" href="union__ENetProtocol.html">ENetProtocol</a> *command, <a class="el" href="types_8h.html#a245102585fdf31bdf208639ef47bec5d">enet_uint16</a> sentTime)</td></tr>
70<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga67b9b1aceaffe1efe08c9a62de2a9be6"></a><!-- doxytag: member="peer.c::enet_peer_setup_outgoing_command" ref="ga67b9b1aceaffe1efe08c9a62de2a9be6" args="(ENetPeer *peer, ENetOutgoingCommand *outgoingCommand)" -->
71void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_setup_outgoing_command</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="struct__ENetOutgoingCommand.html">ENetOutgoingCommand</a> *outgoingCommand)</td></tr>
72<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0dff073e7882de81bdf46ae8e1bc3883"></a><!-- doxytag: member="peer.c::enet_peer_queue_outgoing_command" ref="ga0dff073e7882de81bdf46ae8e1bc3883" args="(ENetPeer *peer, const ENetProtocol *command, ENetPacket *packet, enet_uint32 offset, enet_uint16 length)" -->
73<a class="el" href="struct__ENetOutgoingCommand.html">ENetOutgoingCommand</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_queue_outgoing_command</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, const <a class="el" href="union__ENetProtocol.html">ENetProtocol</a> *command, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *packet, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> offset, <a class="el" href="types_8h.html#a245102585fdf31bdf208639ef47bec5d">enet_uint16</a> length)</td></tr>
74<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9e5635d76d32276d211d655d6570bfd5"></a><!-- doxytag: member="peer.c::enet_peer_dispatch_incoming_unreliable_commands" ref="ga9e5635d76d32276d211d655d6570bfd5" args="(ENetPeer *peer, ENetChannel *channel)" -->
75void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_dispatch_incoming_unreliable_commands</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="struct__ENetChannel.html">ENetChannel</a> *channel)</td></tr>
76<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8b260c7d620fa30772db1426daf15ad0"></a><!-- doxytag: member="peer.c::enet_peer_dispatch_incoming_reliable_commands" ref="ga8b260c7d620fa30772db1426daf15ad0" args="(ENetPeer *peer, ENetChannel *channel)" -->
77void&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_dispatch_incoming_reliable_commands</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, <a class="el" href="struct__ENetChannel.html">ENetChannel</a> *channel)</td></tr>
78<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad48f786cc1fa1b2453a1da9274c7427b"></a><!-- doxytag: member="peer.c::enet_peer_queue_incoming_command" ref="gad48f786cc1fa1b2453a1da9274c7427b" args="(ENetPeer *peer, const ENetProtocol *command, ENetPacket *packet, enet_uint32 fragmentCount)" -->
79<a class="el" href="struct__ENetIncomingCommand.html">ENetIncomingCommand</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enet_peer_queue_incoming_command</b> (<a class="el" href="struct__ENetPeer.html">ENetPeer</a> *peer, const <a class="el" href="union__ENetProtocol.html">ENetProtocol</a> *command, <a class="el" href="struct__ENetPacket.html">ENetPacket</a> *packet, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> fragmentCount)</td></tr>
80</table>
81<hr/><a name="_details"></a><h2>Detailed Description</h2>
82</div>
83<hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by&nbsp;
84<a href="http://www.doxygen.org/index.html">
85<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
86</body>
87</html>