/usr/share/gtk-doc/html/libnice/libnice-Bind.html is in libnice-doc 0.1.1-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Bind</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libnice Reference Manual">
<link rel="up" href="ch04.html" title="STUN usages">
<link rel="prev" href="ch04.html" title="STUN usages">
<link rel="next" href="libnice-ICE.html" title="ICE">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch04.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libnice Reference Manual</th>
<td><a accesskey="n" href="libnice-ICE.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libnice-Bind.synopsis" class="shortcut">Top</a>
|
<a href="#libnice-Bind.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libnice-Bind"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libnice-Bind.top_of_page"></a>Bind</span></h2>
<p>Bind — STUN Binding Usage</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libnice-Bind.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libnice-Bind.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <stun/usages/bind.h>
enum <a class="link" href="libnice-Bind.html#StunUsageBindReturn" title="enum StunUsageBindReturn">StunUsageBindReturn</a>;
<span class="returnvalue">size_t</span> <a class="link" href="libnice-Bind.html#stun-usage-bind-create" title="stun_usage_bind_create ()">stun_usage_bind_create</a> (<em class="parameter"><code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent"><span class="type">StunAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>,
<em class="parameter"><code><span class="type">uint8_t</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">size_t</span> buffer_len</code></em>);
<a class="link" href="libnice-Bind.html#StunUsageBindReturn" title="enum StunUsageBindReturn"><span class="returnvalue">StunUsageBindReturn</span></a> <a class="link" href="libnice-Bind.html#stun-usage-bind-process" title="stun_usage_bind_process ()">stun_usage_bind_process</a> (<em class="parameter"><code><a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>,
<em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *addrlen</code></em>,
<em class="parameter"><code><span class="type">struct sockaddr</span> *alternate_server</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *alternate_server_len</code></em>);
<span class="returnvalue">size_t</span> <a class="link" href="libnice-Bind.html#stun-usage-bind-keepalive" title="stun_usage_bind_keepalive ()">stun_usage_bind_keepalive</a> (<em class="parameter"><code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent"><span class="type">StunAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>,
<em class="parameter"><code><span class="type">uint8_t</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>);
<a class="link" href="libnice-Bind.html#StunUsageBindReturn" title="enum StunUsageBindReturn"><span class="returnvalue">StunUsageBindReturn</span></a> <a class="link" href="libnice-Bind.html#stun-usage-bind-run" title="stun_usage_bind_run ()">stun_usage_bind_run</a> (<em class="parameter"><code>const <span class="type">struct sockaddr</span> *srv</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> srvlen</code></em>,
<em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *addrlen</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libnice-Bind.description"></a><h2>Description</h2>
<p>
The STUN Binding usage allows for easily creating and parsing STUN Binding
requests and responses. It offers both an asynchronous and a synchronous API
that uses the STUN timer usage.
</p>
</div>
<div class="refsect1">
<a name="libnice-Bind.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="StunUsageBindReturn"></a><h3>enum StunUsageBindReturn</h3>
<pre class="programlisting">typedef enum {
STUN_USAGE_BIND_RETURN_SUCCESS,
STUN_USAGE_BIND_RETURN_ERROR,
STUN_USAGE_BIND_RETURN_INVALID,
STUN_USAGE_BIND_RETURN_ALTERNATE_SERVER,
STUN_USAGE_BIND_RETURN_TIMEOUT,
} StunUsageBindReturn;
</pre>
<p>
Return value of <a class="link" href="libnice-Bind.html#stun-usage-bind-process" title="stun_usage_bind_process ()"><code class="function">stun_usage_bind_process()</code></a> and <a class="link" href="libnice-Bind.html#stun-usage-bind-run" title="stun_usage_bind_run ()"><code class="function">stun_usage_bind_run()</code></a> which
allows you to see what status the function call returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="STUN-USAGE-BIND-RETURN-SUCCESS:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_BIND_RETURN_SUCCESS</code></span></p></td>
<td>The binding usage succeeded
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-BIND-RETURN-ERROR:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_BIND_RETURN_ERROR</code></span></p></td>
<td>There was an unknown error in the bind usage
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-BIND-RETURN-INVALID:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_BIND_RETURN_INVALID</code></span></p></td>
<td>The message is invalid and should be ignored
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-BIND-RETURN-ALTERNATE-SERVER:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_BIND_RETURN_ALTERNATE_SERVER</code></span></p></td>
<td>The binding request has an
ALTERNATE-SERVER attribute
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-BIND-RETURN-TIMEOUT:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_BIND_RETURN_TIMEOUT</code></span></p></td>
<td>The binding was unsuccessful because it has
timed out.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="stun-usage-bind-create"></a><h3>stun_usage_bind_create ()</h3>
<pre class="programlisting"><span class="returnvalue">size_t</span> stun_usage_bind_create (<em class="parameter"><code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent"><span class="type">StunAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>,
<em class="parameter"><code><span class="type">uint8_t</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">size_t</span> buffer_len</code></em>);</pre>
<p>
Create a new STUN binding request to use with a STUN server.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>agent</code></em> :</span></p></td>
<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent"><span class="type">StunAgent</span></a> to use to create the binding request</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> to build</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>The buffer to use for creating the <a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer_len</code></em> :</span></p></td>
<td>The size of the <em class="parameter"><code>buffer</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The length of the built message.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="stun-usage-bind-process"></a><h3>stun_usage_bind_process ()</h3>
<pre class="programlisting"><a class="link" href="libnice-Bind.html#StunUsageBindReturn" title="enum StunUsageBindReturn"><span class="returnvalue">StunUsageBindReturn</span></a> stun_usage_bind_process (<em class="parameter"><code><a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>,
<em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *addrlen</code></em>,
<em class="parameter"><code><span class="type">struct sockaddr</span> *alternate_server</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *alternate_server_len</code></em>);</pre>
<p>
Process a STUN binding response and extracts the mapped address from the STUN
message. Also checks for the ALTERNATE-SERVER attribute.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> to process</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>A pointer to a <span class="type">sockaddr</span> structure to fill with the mapped address
that the STUN server gives us</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addrlen</code></em> :</span></p></td>
<td>The length of <em class="parameter"><code>add</code></em>. rMust be set to the size of the <em class="parameter"><code>addr</code></em> socket
address and will be set to the actual length of the socket address.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>alternate_server</code></em> :</span></p></td>
<td>A pointer to a <span class="type">sockaddr</span> structure to fill with the
address of an alternate server to which we should send our new STUN
binding request, in case the currently used STUN server is requesting the use
of an alternate server. This argument will only be filled if the return value
of the function is <a class="link" href="libnice-Bind.html#STUN-USAGE-BIND-RETURN-ALTERNATE-SERVER:CAPS"><span class="type">STUN_USAGE_BIND_RETURN_ALTERNATE_SERVER</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>alternate_server_len</code></em> :</span></p></td>
<td>The length of <em class="parameter"><code>alternate_server</code></em>. Must be set to
the size of the <em class="parameter"><code>alternate_server</code></em> socket address and will be set to the
actual length of the socket address.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="libnice-Bind.html#StunUsageBindReturn" title="enum StunUsageBindReturn"><span class="type">StunUsageBindReturn</span></a> value.
Note that <a class="link" href="libnice-Bind.html#STUN-USAGE-BIND-RETURN-TIMEOUT:CAPS"><span class="type">STUN_USAGE_BIND_RETURN_TIMEOUT</span></a> cannot be returned by this function</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="stun-usage-bind-keepalive"></a><h3>stun_usage_bind_keepalive ()</h3>
<pre class="programlisting"><span class="returnvalue">size_t</span> stun_usage_bind_keepalive (<em class="parameter"><code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent"><span class="type">StunAgent</span></a> *agent</code></em>,
<em class="parameter"><code><a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>,
<em class="parameter"><code><span class="type">uint8_t</span> *buf</code></em>,
<em class="parameter"><code><span class="type">size_t</span> len</code></em>);</pre>
<p>
Creates a STUN binding indication that can be used for a keepalive.
Since this is an indication message, no STUN response will be generated
and it can only be used as a keepalive message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>agent</code></em> :</span></p></td>
<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent"><span class="type">StunAgent</span></a> to use to build the message</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> to build</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
<td>The buffer to use for creating the <a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
<td>The size of the <em class="parameter"><code>buf</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The length of the message to send</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="stun-usage-bind-run"></a><h3>stun_usage_bind_run ()</h3>
<pre class="programlisting"><a class="link" href="libnice-Bind.html#StunUsageBindReturn" title="enum StunUsageBindReturn"><span class="returnvalue">StunUsageBindReturn</span></a> stun_usage_bind_run (<em class="parameter"><code>const <span class="type">struct sockaddr</span> *srv</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> srvlen</code></em>,
<em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> *addrlen</code></em>);</pre>
<p>
This is a convenience function that will do a synchronous Binding request to
a server and wait for its answer. It will create the socket transports and
use the <a class="link" href="libnice-Timer.html#StunTimer" title="StunTimer"><span class="type">StunTimer</span></a> usage to send the request and handle the response.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>srv</code></em> :</span></p></td>
<td>A pointer to the <span class="type">sockaddr</span> structure representing the STUN server's
address</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>srvlen</code></em> :</span></p></td>
<td>The length of <em class="parameter"><code>srv</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
<td>A pointer to a <span class="type">sockaddr</span> structure to fill with the mapped address
that the STUN server gives us</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>addrlen</code></em> :</span></p></td>
<td>The length of <em class="parameter"><code>addr</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="libnice-Bind.html#StunUsageBindReturn" title="enum StunUsageBindReturn"><span class="type">StunUsageBindReturn</span></a>.
Possible return values are <a class="link" href="libnice-Bind.html#STUN-USAGE-BIND-RETURN-SUCCESS:CAPS"><span class="type">STUN_USAGE_BIND_RETURN_SUCCESS</span></a>,
<a class="link" href="libnice-Bind.html#STUN-USAGE-BIND-RETURN-ERROR:CAPS"><span class="type">STUN_USAGE_BIND_RETURN_ERROR</span></a> and <a class="link" href="libnice-Bind.html#STUN-USAGE-BIND-RETURN-TIMEOUT:CAPS"><span class="type">STUN_USAGE_BIND_RETURN_TIMEOUT</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|