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 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>enet: ENet address functions</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul></div>
<h1>ENet address functions</h1>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#g32a6ae1ed3d7704858f237688e7384ee">enet_address_set_host</a> (<a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, const char *hostName)</td></tr>
<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="#g32a6ae1ed3d7704858f237688e7384ee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#g770507a74d2e98334eebdadd9c681f69">enet_address_get_host_ip</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *hostName, size_t nameLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gives the printable form of the ip address specified in the address parameter. <a href="#g770507a74d2e98334eebdadd9c681f69"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#g55282b3074cb409544f6aa72a67582ab">enet_address_get_host</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *hostName, size_t nameLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to do a reverse lookup of the host field in the address parameter. <a href="#g55282b3074cb409544f6aa72a67582ab"></a><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g55282b3074cb409544f6aa72a67582ab"></a><!-- doxytag: member="enet.h::enet_address_get_host" ref="g55282b3074cb409544f6aa72a67582ab" args="(const ENetAddress *address, char *hostName, size_t nameLength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ENET_API int enet_address_get_host </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> * </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>hostName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>nameLength</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>address used for reverse lookup </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hostName</em> </td><td>destination for name, must not be NULL </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nameLength</em> </td><td>maximum length of hostName. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the null-terminated name of the host in hostName on success </dd></dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>on success </td></tr>
<tr><td valign="top"></td><td valign="top"><em><</em> </td><td>0 on failure </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g770507a74d2e98334eebdadd9c681f69"></a><!-- doxytag: member="enet.h::enet_address_get_host_ip" ref="g770507a74d2e98334eebdadd9c681f69" args="(const ENetAddress *address, char *hostName, size_t nameLength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ENET_API int enet_address_get_host_ip </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> * </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>hostName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>nameLength</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>address printed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hostName</em> </td><td>destination for name, must not be NULL </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nameLength</em> </td><td>maximum length of hostName. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the null-terminated name of the host in hostName on success </dd></dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>on success </td></tr>
<tr><td valign="top"></td><td valign="top"><em><</em> </td><td>0 on failure </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g32a6ae1ed3d7704858f237688e7384ee"></a><!-- doxytag: member="enet.h::enet_address_set_host" ref="g32a6ae1ed3d7704858f237688e7384ee" args="(ENetAddress *address, const char *hostName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ENET_API int enet_address_set_host </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__ENetAddress.html">ENetAddress</a> * </td>
<td class="paramname"> <em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>hostName</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>destination to store resolved address </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hostName</em> </td><td>host name to lookup </td></tr>
</table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>on success </td></tr>
<tr><td valign="top"></td><td valign="top"><em><</em> </td><td>0 on failure </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the address of the given hostName in address on success </dd></dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Wed Jun 6 14:33:50 2007 for enet by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
|