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

/src/middleware/enet/docs/group__Address.html

https://bitbucket.org/vivkin/gam3b00bs/
HTML | 189 lines | 183 code | 5 blank | 1 comment | 0 complexity | 2cb6648fd5ec2a880ae2f9d86479f533 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: ENet address functions</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><a href="files.html"><span>Files</span></a></li>
 19    </ul>
 20  </div>
 21</div>
 22<div class="header">
 23  <div class="summary">
 24<a href="#func-members">Functions</a>  </div>
 25  <div class="headertitle">
 26<h1>ENet address functions</h1>  </div>
 27</div>
 28<div class="contents">
 29<table class="memberdecls">
 30<tr><td colspan="2"><h2><a name="func-members"></a>
 31Functions</h2></td></tr>
 32<tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</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 *hostName)</td></tr>
 33<tr><td class="mdescLeft">&nbsp;</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="#ga32a6ae1ed3d7704858f237688e7384ee"></a><br/></td></tr>
 34<tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</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 *hostName, size_t nameLength)</td></tr>
 35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gives the printable form of the ip address specified in the address parameter.  <a href="#ga770507a74d2e98334eebdadd9c681f69"></a><br/></td></tr>
 36<tr><td class="memItemLeft" align="right" valign="top">ENET_API int&nbsp;</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 *hostName, size_t nameLength)</td></tr>
 37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to do a reverse lookup of the host field in the address parameter.  <a href="#ga55282b3074cb409544f6aa72a67582ab"></a><br/></td></tr>
 38</table>
 39<hr/><h2>Function Documentation</h2>
 40<a class="anchor" id="ga55282b3074cb409544f6aa72a67582ab"></a><!-- doxytag: member="enet.h::enet_address_get_host" ref="ga55282b3074cb409544f6aa72a67582ab" args="(const ENetAddress *address, char *hostName, size_t nameLength)" -->
 41<div class="memitem">
 42<div class="memproto">
 43      <table class="memname">
 44        <tr>
 45          <td class="memname">ENET_API int enet_address_get_host </td>
 46          <td>(</td>
 47          <td class="paramtype">const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *&nbsp;</td>
 48          <td class="paramname"> <em>address</em>, </td>
 49        </tr>
 50        <tr>
 51          <td class="paramkey"></td>
 52          <td></td>
 53          <td class="paramtype">char *&nbsp;</td>
 54          <td class="paramname"> <em>hostName</em>, </td>
 55        </tr>
 56        <tr>
 57          <td class="paramkey"></td>
 58          <td></td>
 59          <td class="paramtype">size_t&nbsp;</td>
 60          <td class="paramname"> <em>nameLength</em></td><td>&nbsp;</td>
 61        </tr>
 62        <tr>
 63          <td></td>
 64          <td>)</td>
 65          <td></td><td></td><td></td>
 66        </tr>
 67      </table>
 68</div>
 69<div class="memdoc">
 70<dl><dt><b>Parameters:</b></dt><dd>
 71  <table border="0" cellspacing="2" cellpadding="0">
 72    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>address used for reverse lookup </td></tr>
 73    <tr><td valign="top"></td><td valign="top"><em>hostName</em>&nbsp;</td><td>destination for name, must not be NULL </td></tr>
 74    <tr><td valign="top"></td><td valign="top"><em>nameLength</em>&nbsp;</td><td>maximum length of hostName. </td></tr>
 75  </table>
 76  </dd>
 77</dl>
 78<dl class="return"><dt><b>Returns:</b></dt><dd>the null-terminated name of the host in hostName on success </dd></dl>
 79<dl><dt><b>Return values:</b></dt><dd>
 80  <table border="0" cellspacing="2" cellpadding="0">
 81    <tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>on success </td></tr>
 82    <tr><td valign="top"></td><td valign="top"><em>&lt;</em>&nbsp;</td><td>0 on failure </td></tr>
 83  </table>
 84  </dd>
 85</dl>
 86
 87<p>References <a class="el" href="group__Address.html#ga770507a74d2e98334eebdadd9c681f69">enet_address_get_host_ip()</a>.</p>
 88
 89</div>
 90</div>
 91<a class="anchor" id="ga770507a74d2e98334eebdadd9c681f69"></a><!-- doxytag: member="enet.h::enet_address_get_host_ip" ref="ga770507a74d2e98334eebdadd9c681f69" args="(const ENetAddress *address, char *hostName, size_t nameLength)" -->
 92<div class="memitem">
 93<div class="memproto">
 94      <table class="memname">
 95        <tr>
 96          <td class="memname">ENET_API int enet_address_get_host_ip </td>
 97          <td>(</td>
 98          <td class="paramtype">const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *&nbsp;</td>
 99          <td class="paramname"> <em>address</em>, </td>
100        </tr>
101        <tr>
102          <td class="paramkey"></td>
103          <td></td>
104          <td class="paramtype">char *&nbsp;</td>
105          <td class="paramname"> <em>hostName</em>, </td>
106        </tr>
107        <tr>
108          <td class="paramkey"></td>
109          <td></td>
110          <td class="paramtype">size_t&nbsp;</td>
111          <td class="paramname"> <em>nameLength</em></td><td>&nbsp;</td>
112        </tr>
113        <tr>
114          <td></td>
115          <td>)</td>
116          <td></td><td></td><td></td>
117        </tr>
118      </table>
119</div>
120<div class="memdoc">
121<dl><dt><b>Parameters:</b></dt><dd>
122  <table border="0" cellspacing="2" cellpadding="0">
123    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>address printed </td></tr>
124    <tr><td valign="top"></td><td valign="top"><em>hostName</em>&nbsp;</td><td>destination for name, must not be NULL </td></tr>
125    <tr><td valign="top"></td><td valign="top"><em>nameLength</em>&nbsp;</td><td>maximum length of hostName. </td></tr>
126  </table>
127  </dd>
128</dl>
129<dl class="return"><dt><b>Returns:</b></dt><dd>the null-terminated name of the host in hostName on success </dd></dl>
130<dl><dt><b>Return values:</b></dt><dd>
131  <table border="0" cellspacing="2" cellpadding="0">
132    <tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>on success </td></tr>
133    <tr><td valign="top"></td><td valign="top"><em>&lt;</em>&nbsp;</td><td>0 on failure </td></tr>
134  </table>
135  </dd>
136</dl>
137
138<p>Referenced by <a class="el" href="group__Address.html#ga55282b3074cb409544f6aa72a67582ab">enet_address_get_host()</a>.</p>
139
140</div>
141</div>
142<a class="anchor" id="ga32a6ae1ed3d7704858f237688e7384ee"></a><!-- doxytag: member="enet.h::enet_address_set_host" ref="ga32a6ae1ed3d7704858f237688e7384ee" args="(ENetAddress *address, const char *hostName)" -->
143<div class="memitem">
144<div class="memproto">
145      <table class="memname">
146        <tr>
147          <td class="memname">ENET_API int enet_address_set_host </td>
148          <td>(</td>
149          <td class="paramtype"><a class="el" href="struct__ENetAddress.html">ENetAddress</a> *&nbsp;</td>
150          <td class="paramname"> <em>address</em>, </td>
151        </tr>
152        <tr>
153          <td class="paramkey"></td>
154          <td></td>
155          <td class="paramtype">const char *&nbsp;</td>
156          <td class="paramname"> <em>hostName</em></td><td>&nbsp;</td>
157        </tr>
158        <tr>
159          <td></td>
160          <td>)</td>
161          <td></td><td></td><td></td>
162        </tr>
163      </table>
164</div>
165<div class="memdoc">
166<dl><dt><b>Parameters:</b></dt><dd>
167  <table border="0" cellspacing="2" cellpadding="0">
168    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>destination to store resolved address </td></tr>
169    <tr><td valign="top"></td><td valign="top"><em>hostName</em>&nbsp;</td><td>host name to lookup </td></tr>
170  </table>
171  </dd>
172</dl>
173<dl><dt><b>Return values:</b></dt><dd>
174  <table border="0" cellspacing="2" cellpadding="0">
175    <tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>on success </td></tr>
176    <tr><td valign="top"></td><td valign="top"><em>&lt;</em>&nbsp;</td><td>0 on failure </td></tr>
177  </table>
178  </dd>
179</dl>
180<dl class="return"><dt><b>Returns:</b></dt><dd>the address of the given hostName in address on success </dd></dl>
181
182</div>
183</div>
184</div>
185<hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 21:31:05 for enet by&nbsp;
186<a href="http://www.doxygen.org/index.html">
187<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
188</body>
189</html>