/src/middleware/enet/docs/unix_8c.html
HTML | 130 lines | 126 code | 3 blank | 1 comment | 0 complexity | 9b8cae8ada02a821c2f1d6bc9c0ffbf4 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: unix.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 Page</span></a></li> 15 <li><a href="pages.html"><span>Related Pages</span></a></li> 16 <li><a href="modules.html"><span>Modules</span></a></li> 17 <li><a href="annotated.html"><span>Data 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 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> | 31<a href="#typedef-members">Typedefs</a> | 32<a href="#func-members">Functions</a> </div> 33 <div class="headertitle"> 34<h1>unix.c File Reference</h1> </div> 35</div> 36<div class="contents"> 37 38<p>ENet Unix system specific functions. 39<a href="#_details">More...</a></p> 40<code>#include <sys/types.h></code><br/> 41<code>#include <sys/socket.h></code><br/> 42<code>#include <sys/ioctl.h></code><br/> 43<code>#include <sys/time.h></code><br/> 44<code>#include <arpa/inet.h></code><br/> 45<code>#include <netdb.h></code><br/> 46<code>#include <unistd.h></code><br/> 47<code>#include <string.h></code><br/> 48<code>#include <errno.h></code><br/> 49<code>#include <<a class="el" href="time_8h_source.html">time.h</a>></code><br/> 50<code>#include "<a class="el" href="enet_8h_source.html">enet/enet.h</a>"</code><br/> 51<table class="memberdecls"> 52<tr><td colspan="2"><h2><a name="define-members"></a> 53Defines</h2></td></tr> 54<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0dc3ac14ddf12c81cb53d3e662ad277f"></a><!-- doxytag: member="unix.c::ENET_BUILDING_LIB" ref="a0dc3ac14ddf12c81cb53d3e662ad277f" args="" --> 55#define </td><td class="memItemRight" valign="bottom"><b>ENET_BUILDING_LIB</b> 1</td></tr> 56<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f55d0e90dc8cc6b2287312435cdde48"></a><!-- doxytag: member="unix.c::MSG_NOSIGNAL" ref="a9f55d0e90dc8cc6b2287312435cdde48" args="" --> 57#define </td><td class="memItemRight" valign="bottom"><b>MSG_NOSIGNAL</b> 0</td></tr> 58<tr><td colspan="2"><h2><a name="typedef-members"></a> 59Typedefs</h2></td></tr> 60<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b82106923cc13b3a9734520ecc29514"></a><!-- doxytag: member="unix.c::socklen_t" ref="a6b82106923cc13b3a9734520ecc29514" args="" --> 61typedef int </td><td class="memItemRight" valign="bottom"><b>socklen_t</b></td></tr> 62<tr><td colspan="2"><h2><a name="func-members"></a> 63Functions</h2></td></tr> 64<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#ga67fa85c46a1dc91f968f25fc0637c897">enet_initialize</a> (void)</td></tr> 65<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes ENet globally. <a href="group__global.html#ga67fa85c46a1dc91f968f25fc0637c897"></a><br/></td></tr> 66<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__global.html#gad62cf417e08a2b98d48572a336f7db25">enet_deinitialize</a> (void)</td></tr> 67<tr><td class="mdescLeft"> </td><td class="mdescRight">Shuts down ENet globally. <a href="group__global.html#gad62cf417e08a2b98d48572a336f7db25"></a><br/></td></tr> 68<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="unix_8c.html#a26eeed004fe8fa39b0fb5b18efbd4d64">enet_time_get</a> (void)</td></tr> 69<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the wall-time in milliseconds. <a href="#a26eeed004fe8fa39b0fb5b18efbd4d64"></a><br/></td></tr> 70<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af7346c361d30381752ac89475a5e1fd5"></a><!-- doxytag: member="unix.c::enet_time_set" ref="af7346c361d30381752ac89475a5e1fd5" args="(enet_uint32 newTimeBase)" --> 71void </td><td class="memItemRight" valign="bottom"><a class="el" href="unix_8c.html#af7346c361d30381752ac89475a5e1fd5">enet_time_set</a> (<a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> newTimeBase)</td></tr> 72<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the current wall-time in milliseconds. <br/></td></tr> 73<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#ga32a6ae1ed3d7704858f237688e7384ee">enet_address_set_host</a> (<a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, const char *name)</td></tr> 74<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to resolve the host named by the parameter hostName and sets the host field in the address parameter if successful. <a href="group__Address.html#ga32a6ae1ed3d7704858f237688e7384ee"></a><br/></td></tr> 75<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#ga770507a74d2e98334eebdadd9c681f69">enet_address_get_host_ip</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *name, size_t nameLength)</td></tr> 76<tr><td class="mdescLeft"> </td><td class="mdescRight">Gives the printable form of the ip address specified in the address parameter. <a href="group__Address.html#ga770507a74d2e98334eebdadd9c681f69"></a><br/></td></tr> 77<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#ga55282b3074cb409544f6aa72a67582ab">enet_address_get_host</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *name, size_t nameLength)</td></tr> 78<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to do a reverse lookup of the host field in the address parameter. <a href="group__Address.html#ga55282b3074cb409544f6aa72a67582ab"></a><br/></td></tr> 79<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1e8cc186381f15397c5523b2ff9d4cf0"></a><!-- doxytag: member="unix.c::enet_socket_bind" ref="ga1e8cc186381f15397c5523b2ff9d4cf0" args="(ENetSocket socket, const ENetAddress *address)" --> 80int </td><td class="memItemRight" valign="bottom"><b>enet_socket_bind</b> (ENetSocket socket, const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address)</td></tr> 81<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad1ed276acc8e120bc353815d842c6b87"></a><!-- doxytag: member="unix.c::enet_socket_listen" ref="gad1ed276acc8e120bc353815d842c6b87" args="(ENetSocket socket, int backlog)" --> 82int </td><td class="memItemRight" valign="bottom"><b>enet_socket_listen</b> (ENetSocket socket, int backlog)</td></tr> 83<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga425a4420e37f3c46ced4f28091786c44"></a><!-- doxytag: member="unix.c::enet_socket_create" ref="ga425a4420e37f3c46ced4f28091786c44" args="(ENetSocketType type)" --> 84ENetSocket </td><td class="memItemRight" valign="bottom"><b>enet_socket_create</b> (ENetSocketType type)</td></tr> 85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6fcb9b55e15648bd9aeed81ab9187ad7"></a><!-- doxytag: member="unix.c::enet_socket_set_option" ref="ga6fcb9b55e15648bd9aeed81ab9187ad7" args="(ENetSocket socket, ENetSocketOption option, int value)" --> 86int </td><td class="memItemRight" valign="bottom"><b>enet_socket_set_option</b> (ENetSocket socket, ENetSocketOption option, int value)</td></tr> 87<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac657e370f1585ce2e0f42b35f28b0d29"></a><!-- doxytag: member="unix.c::enet_socket_connect" ref="gac657e370f1585ce2e0f42b35f28b0d29" args="(ENetSocket socket, const ENetAddress *address)" --> 88int </td><td class="memItemRight" valign="bottom"><b>enet_socket_connect</b> (ENetSocket socket, const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address)</td></tr> 89<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaaf0f06f15ce99ba362250d6c5768866e"></a><!-- doxytag: member="unix.c::enet_socket_accept" ref="gaaf0f06f15ce99ba362250d6c5768866e" args="(ENetSocket socket, ENetAddress *address)" --> 90ENetSocket </td><td class="memItemRight" valign="bottom"><b>enet_socket_accept</b> (ENetSocket socket, <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address)</td></tr> 91<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7b4933cda2967776397c23538cacadea"></a><!-- doxytag: member="unix.c::enet_socket_destroy" ref="ga7b4933cda2967776397c23538cacadea" args="(ENetSocket socket)" --> 92void </td><td class="memItemRight" valign="bottom"><b>enet_socket_destroy</b> (ENetSocket socket)</td></tr> 93<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7b31df6015f1f2b4850dfbf63ccc10ac"></a><!-- doxytag: member="unix.c::enet_socket_send" ref="ga7b31df6015f1f2b4850dfbf63ccc10ac" args="(ENetSocket socket, const ENetAddress *address, const ENetBuffer *buffers, size_t bufferCount)" --> 94int </td><td class="memItemRight" valign="bottom"><b>enet_socket_send</b> (ENetSocket socket, const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, const <a class="el" href="structENetBuffer.html">ENetBuffer</a> *buffers, size_t bufferCount)</td></tr> 95<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga119dba4de09aca16bd936953c8bc9853"></a><!-- doxytag: member="unix.c::enet_socket_receive" ref="ga119dba4de09aca16bd936953c8bc9853" args="(ENetSocket socket, ENetAddress *address, ENetBuffer *buffers, size_t bufferCount)" --> 96int </td><td class="memItemRight" valign="bottom"><b>enet_socket_receive</b> (ENetSocket socket, <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, <a class="el" href="structENetBuffer.html">ENetBuffer</a> *buffers, size_t bufferCount)</td></tr> 97<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5ff9e22bd329293141a2d6c1f71279cc"></a><!-- doxytag: member="unix.c::enet_socketset_select" ref="ga5ff9e22bd329293141a2d6c1f71279cc" args="(ENetSocket maxSocket, ENetSocketSet *readSet, ENetSocketSet *writeSet, enet_uint32 timeout)" --> 98int </td><td class="memItemRight" valign="bottom"><b>enet_socketset_select</b> (ENetSocket maxSocket, ENetSocketSet *readSet, ENetSocketSet *writeSet, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> timeout)</td></tr> 99<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga06158e2adcfa90f18c9fdd13b7101231"></a><!-- doxytag: member="unix.c::enet_socket_wait" ref="ga06158e2adcfa90f18c9fdd13b7101231" args="(ENetSocket socket, enet_uint32 *condition, enet_uint32 timeout)" --> 100int </td><td class="memItemRight" valign="bottom"><b>enet_socket_wait</b> (ENetSocket socket, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> *condition, <a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> timeout)</td></tr> 101</table> 102<hr/><a name="_details"></a><h2>Detailed Description</h2> 103<hr/><h2>Function Documentation</h2> 104<a class="anchor" id="a26eeed004fe8fa39b0fb5b18efbd4d64"></a><!-- doxytag: member="unix.c::enet_time_get" ref="a26eeed004fe8fa39b0fb5b18efbd4d64" args="(void)" --> 105<div class="memitem"> 106<div class="memproto"> 107 <table class="memname"> 108 <tr> 109 <td class="memname"><a class="el" href="types_8h.html#a5273659ca3c664b8550452732e9e4ae3">enet_uint32</a> enet_time_get </td> 110 <td>(</td> 111 <td class="paramtype">void </td> 112 <td class="paramname"></td> 113 <td> ) </td> 114 <td></td> 115 </tr> 116 </table> 117</div> 118<div class="memdoc"> 119<p>Its initial value is unspecified unless otherwise set. </p> 120 121<p>Referenced by <a class="el" href="group__host.html#gac8f53bcdbd540043f87e7d59048559fa">enet_host_flush()</a>, and <a class="el" href="group__host.html#ga6ba501b3ee576e5578c8e6d1694ebd49">enet_host_service()</a>.</p> 122 123</div> 124</div> 125</div> 126<hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by 127<a href="http://www.doxygen.org/index.html"> 128<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> 129</body> 130</html>