/usr/share/gtk-doc/html/libnice/libnice-ICE.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 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ICE</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="libnice-Bind.html" title="Bind">
<link rel="next" href="libnice-TURN.html" title="TURN">
<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="libnice-Bind.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-TURN.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-ICE.synopsis" class="shortcut">Top</a>
|
<a href="#libnice-ICE.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libnice-ICE"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libnice-ICE.top_of_page"></a>ICE</span></h2>
<p>ICE — STUN ICE Usage</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libnice-ICE.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libnice-ICE.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <stun/usages/ice.h>
enum <a class="link" href="libnice-ICE.html#StunUsageIceCompatibility" title="enum StunUsageIceCompatibility">StunUsageIceCompatibility</a>;
enum <a class="link" href="libnice-ICE.html#StunUsageIceReturn" title="enum StunUsageIceReturn">StunUsageIceReturn</a>;
<span class="returnvalue">size_t</span> <a class="link" href="libnice-ICE.html#stun-usage-ice-conncheck-create" title="stun_usage_ice_conncheck_create ()">stun_usage_ice_conncheck_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>,
<em class="parameter"><code>const <span class="type">uint8_t</span> *username</code></em>,
<em class="parameter"><code>const <span class="type">size_t</span> username_len</code></em>,
<em class="parameter"><code>const <span class="type">uint8_t</span> *password</code></em>,
<em class="parameter"><code>const <span class="type">size_t</span> password_len</code></em>,
<em class="parameter"><code><span class="type">bool</span> cand_use</code></em>,
<em class="parameter"><code><span class="type">bool</span> controlling</code></em>,
<em class="parameter"><code><span class="type">uint32_t</span> priority</code></em>,
<em class="parameter"><code><span class="type">uint64_t</span> tie</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *candidate_identifier</code></em>,
<em class="parameter"><code><a class="link" href="libnice-ICE.html#StunUsageIceCompatibility" title="enum StunUsageIceCompatibility"><span class="type">StunUsageIceCompatibility</span></a> compatibility</code></em>);
<a class="link" href="libnice-ICE.html#StunUsageIceReturn" title="enum StunUsageIceReturn"><span class="returnvalue">StunUsageIceReturn</span></a> <a class="link" href="libnice-ICE.html#stun-usage-ice-conncheck-process" title="stun_usage_ice_conncheck_process ()">stun_usage_ice_conncheck_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><a class="link" href="libnice-ICE.html#StunUsageIceCompatibility" title="enum StunUsageIceCompatibility"><span class="type">StunUsageIceCompatibility</span></a> compatibility</code></em>);
<a class="link" href="libnice-ICE.html#StunUsageIceReturn" title="enum StunUsageIceReturn"><span class="returnvalue">StunUsageIceReturn</span></a> <a class="link" href="libnice-ICE.html#stun-usage-ice-conncheck-create-reply" title="stun_usage_ice_conncheck_create_reply ()">stun_usage_ice_conncheck_create_reply</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> *req</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> *plen</code></em>,
<em class="parameter"><code>const <span class="type">struct sockaddr</span> *src</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> srclen</code></em>,
<em class="parameter"><code><span class="type">bool</span> *control</code></em>,
<em class="parameter"><code><span class="type">uint64_t</span> tie</code></em>,
<em class="parameter"><code><a class="link" href="libnice-ICE.html#StunUsageIceCompatibility" title="enum StunUsageIceCompatibility"><span class="type">StunUsageIceCompatibility</span></a> compatibility</code></em>);
<span class="returnvalue">uint32_t</span> <a class="link" href="libnice-ICE.html#stun-usage-ice-conncheck-priority" title="stun_usage_ice_conncheck_priority ()">stun_usage_ice_conncheck_priority</a> (<em class="parameter"><code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>);
<span class="returnvalue">bool</span> <a class="link" href="libnice-ICE.html#stun-usage-ice-conncheck-use-candidate" title="stun_usage_ice_conncheck_use_candidate ()">stun_usage_ice_conncheck_use_candidate</a>
(<em class="parameter"><code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libnice-ICE.description"></a><h2>Description</h2>
<p>
The STUN ICE usage allows for easily creating and parsing STUN Binding
requests and responses used for ICE connectivity checks. The API allows you
to create a connectivity check message, parse a response or create a reply
to an incoming connectivity check request.
</p>
</div>
<div class="refsect1">
<a name="libnice-ICE.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="StunUsageIceCompatibility"></a><h3>enum StunUsageIceCompatibility</h3>
<pre class="programlisting">typedef enum {
STUN_USAGE_ICE_COMPATIBILITY_RFC5245,
STUN_USAGE_ICE_COMPATIBILITY_GOOGLE,
STUN_USAGE_ICE_COMPATIBILITY_MSN,
STUN_USAGE_ICE_COMPATIBILITY_WLM2009,
STUN_USAGE_ICE_COMPATIBILITY_DRAFT19 = STUN_USAGE_ICE_COMPATIBILITY_RFC5245,
} StunUsageIceCompatibility;
</pre>
<p>
This enum defines which compatibility modes this ICE usage can use
</p>
<p>
</p>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<em class="parameter"><code>STUN_USAGE_ICE_COMPATIBILITY_DRAFT19</code></em> is deprecated and should not
be used in newly-written code. It is kept for compatibility reasons and
represents the same compatibility as <em class="parameter"><code>STUN_USAGE_ICE_COMPATIBILITY_RFC5245</code></em>
</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="STUN-USAGE-ICE-COMPATIBILITY-RFC5245:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_COMPATIBILITY_RFC5245</code></span></p></td>
<td>The ICE compatibility with RFC 5245
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-COMPATIBILITY-GOOGLE:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_COMPATIBILITY_GOOGLE</code></span></p></td>
<td>The ICE compatibility with Google's
implementation of ICE
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-COMPATIBILITY-MSN:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_COMPATIBILITY_MSN</code></span></p></td>
<td>The ICE compatibility with MSN's
implementation of ICE
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-COMPATIBILITY-WLM2009:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_COMPATIBILITY_WLM2009</code></span></p></td>
<td>The ICE compatibility with Windows
Live Messenger and Microsoft Office Communicator 2007 R2 implementation of ICE
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-COMPATIBILITY-DRAFT19:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_COMPATIBILITY_DRAFT19</code></span></p></td>
<td>The ICE compatibility with draft 19
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="StunUsageIceReturn"></a><h3>enum StunUsageIceReturn</h3>
<pre class="programlisting">typedef enum {
STUN_USAGE_ICE_RETURN_SUCCESS,
STUN_USAGE_ICE_RETURN_ERROR,
STUN_USAGE_ICE_RETURN_INVALID,
STUN_USAGE_ICE_RETURN_ROLE_CONFLICT,
STUN_USAGE_ICE_RETURN_INVALID_REQUEST,
STUN_USAGE_ICE_RETURN_INVALID_METHOD,
STUN_USAGE_ICE_RETURN_MEMORY_ERROR,
STUN_USAGE_ICE_RETURN_INVALID_ADDRESS,
STUN_USAGE_ICE_RETURN_NO_MAPPED_ADDRESS,
} StunUsageIceReturn;
</pre>
<p>
Return value of <a class="link" href="libnice-ICE.html#stun-usage-ice-conncheck-process" title="stun_usage_ice_conncheck_process ()"><code class="function">stun_usage_ice_conncheck_process()</code></a> and
<a class="link" href="libnice-ICE.html#stun-usage-ice-conncheck-create-reply" title="stun_usage_ice_conncheck_create_reply ()"><code class="function">stun_usage_ice_conncheck_create_reply()</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-ICE-RETURN-SUCCESS:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_RETURN_SUCCESS</code></span></p></td>
<td>The function succeeded
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-RETURN-ERROR:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_RETURN_ERROR</code></span></p></td>
<td>There was an unspecified error
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-RETURN-INVALID:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_RETURN_INVALID</code></span></p></td>
<td>The message is invalid for processing
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-RETURN-ROLE-CONFLICT:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_RETURN_ROLE_CONFLICT</code></span></p></td>
<td>A role conflict was detected
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-RETURN-INVALID-REQUEST:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_RETURN_INVALID_REQUEST</code></span></p></td>
<td>The message is an not a request
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-RETURN-INVALID-METHOD:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_RETURN_INVALID_METHOD</code></span></p></td>
<td>The method of the request is invalid
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-RETURN-MEMORY-ERROR:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_RETURN_MEMORY_ERROR</code></span></p></td>
<td>The buffer size is too small to hold
the STUN reply
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-RETURN-INVALID-ADDRESS:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_RETURN_INVALID_ADDRESS</code></span></p></td>
<td>The mapped address argument has
an invalid address family
</td>
</tr>
<tr>
<td><p><a name="STUN-USAGE-ICE-RETURN-NO-MAPPED-ADDRESS:CAPS"></a><span class="term"><code class="literal">STUN_USAGE_ICE_RETURN_NO_MAPPED_ADDRESS</code></span></p></td>
<td>The response is valid but no
MAPPED-ADDRESS or XOR-MAPPED-ADDRESS attribute was found
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="stun-usage-ice-conncheck-create"></a><h3>stun_usage_ice_conncheck_create ()</h3>
<pre class="programlisting"><span class="returnvalue">size_t</span> stun_usage_ice_conncheck_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>,
<em class="parameter"><code>const <span class="type">uint8_t</span> *username</code></em>,
<em class="parameter"><code>const <span class="type">size_t</span> username_len</code></em>,
<em class="parameter"><code>const <span class="type">uint8_t</span> *password</code></em>,
<em class="parameter"><code>const <span class="type">size_t</span> password_len</code></em>,
<em class="parameter"><code><span class="type">bool</span> cand_use</code></em>,
<em class="parameter"><code><span class="type">bool</span> controlling</code></em>,
<em class="parameter"><code><span class="type">uint32_t</span> priority</code></em>,
<em class="parameter"><code><span class="type">uint64_t</span> tie</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *candidate_identifier</code></em>,
<em class="parameter"><code><a class="link" href="libnice-ICE.html#StunUsageIceCompatibility" title="enum StunUsageIceCompatibility"><span class="type">StunUsageIceCompatibility</span></a> compatibility</code></em>);</pre>
<p>
Builds an ICE connectivity check STUN message.
If the compatibility is not <a class="link" href="libnice-ICE.html#STUN-USAGE-ICE-COMPATIBILITY-RFC5245:CAPS"><span class="type">STUN_USAGE_ICE_COMPATIBILITY_RFC5245</span></a>, the
<em class="parameter"><code>cand_use</code></em>, <em class="parameter"><code>controlling</code></em>, <em class="parameter"><code>priority</code></em> and <em class="parameter"><code>tie</code></em> arguments are not used.
If the compatibility is not <a class="link" href="libnice-ICE.html#STUN-USAGE-ICE-COMPATIBILITY-WLM2009:CAPS"><span class="type">STUN_USAGE_ICE_COMPATIBILITY_WLM2009</span></a>, the
<em class="parameter"><code>candidate_identifier</code></em> argument is not used.
</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 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"><em class="parameter"><code>username</code></em> :</span></p></td>
<td>The username to use in the request</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>username_len</code></em> :</span></p></td>
<td>The length of <em class="parameter"><code>username</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
<td>The key to use for building the MESSAGE-INTEGRITY</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>password_len</code></em> :</span></p></td>
<td>The length of <em class="parameter"><code>password</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cand_use</code></em> :</span></p></td>
<td>Set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to append the USE-CANDIDATE flag to the request</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>controlling</code></em> :</span></p></td>
<td>Set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if you are the controlling agent or set to
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if you are the controlled agent.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
<td>The value of the PRIORITY attribute</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tie</code></em> :</span></p></td>
<td>The value of the tie-breaker to put in the ICE-CONTROLLED or
ICE-CONTROLLING attribute</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>candidate_identifier</code></em> :</span></p></td>
<td>The foundation value to put in the
CANDIDATE-IDENTIFIER attribute</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>compatibility</code></em> :</span></p></td>
<td>The compatibility mode to use for building the conncheck
request</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The length of the message built.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="stun-usage-ice-conncheck-process"></a><h3>stun_usage_ice_conncheck_process ()</h3>
<pre class="programlisting"><a class="link" href="libnice-ICE.html#StunUsageIceReturn" title="enum StunUsageIceReturn"><span class="returnvalue">StunUsageIceReturn</span></a> stun_usage_ice_conncheck_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><a class="link" href="libnice-ICE.html#StunUsageIceCompatibility" title="enum StunUsageIceCompatibility"><span class="type">StunUsageIceCompatibility</span></a> compatibility</code></em>);</pre>
<p>
Process an ICE connectivity check STUN message and retreive the
mapped address from the message
</p>
<p> See also <a class="link" href="libnice-ICE.html#stun-usage-ice-conncheck-priority" title="stun_usage_ice_conncheck_priority ()"><code class="function">stun_usage_ice_conncheck_priority()</code></a> and
<a class="link" href="libnice-ICE.html#stun-usage-ice-conncheck-use-candidate" title="stun_usage_ice_conncheck_use_candidate ()"><code class="function">stun_usage_ice_conncheck_use_candidate()</code></a> </p>
<p>
</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 connectivity check response contains</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"><em class="parameter"><code>compatibility</code></em> :</span></p></td>
<td>The compatibility mode to use for processing the conncheck
response</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-ICE.html#StunUsageIceReturn" title="enum StunUsageIceReturn"><span class="type">StunUsageIceReturn</span></a> value</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="stun-usage-ice-conncheck-create-reply"></a><h3>stun_usage_ice_conncheck_create_reply ()</h3>
<pre class="programlisting"><a class="link" href="libnice-ICE.html#StunUsageIceReturn" title="enum StunUsageIceReturn"><span class="returnvalue">StunUsageIceReturn</span></a> stun_usage_ice_conncheck_create_reply
(<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> *req</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> *plen</code></em>,
<em class="parameter"><code>const <span class="type">struct sockaddr</span> *src</code></em>,
<em class="parameter"><code><span class="type">socklen_t</span> srclen</code></em>,
<em class="parameter"><code><span class="type">bool</span> *control</code></em>,
<em class="parameter"><code><span class="type">uint64_t</span> tie</code></em>,
<em class="parameter"><code><a class="link" href="libnice-ICE.html#StunUsageIceCompatibility" title="enum StunUsageIceCompatibility"><span class="type">StunUsageIceCompatibility</span></a> compatibility</code></em>);</pre>
<p>
Tries to parse a STUN connectivity check request and builds a
response accordingly.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
In case of error, the <em class="parameter"><code>msg</code></em> is filled with the appropriate error response
to be sent and the value of <em class="parameter"><code>plen</code></em> is set to the size of that message.
If <em class="parameter"><code>plen</code></em> has a size of 0, then no error response should be sent.
</p>
</div>
<p>
</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 response</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>req</code></em> :</span></p></td>
<td>The original STUN request to reply to</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>plen</code></em> :</span></p></td>
<td>A pointer containing the size of the <em class="parameter"><code>buffer</code></em> on input.
Will contain the length of the message built on output.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
<td>A pointer to a <span class="type">sockaddr</span> structure containing the source address from
which the request was received. Will be used as the mapped address in the
response</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>srclen</code></em> :</span></p></td>
<td>The length of <em class="parameter"><code>addr</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>control</code></em> :</span></p></td>
<td>Set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if you are the controlling agent or set to
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if you are the controlled agent.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tie</code></em> :</span></p></td>
<td>The value of the tie-breaker to put in the ICE-CONTROLLED or
ICE-CONTROLLING attribute</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>compatibility</code></em> :</span></p></td>
<td>The compatibility mode to use for building the conncheck
response</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-ICE.html#StunUsageIceReturn" title="enum StunUsageIceReturn"><span class="type">StunUsageIceReturn</span></a> value</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="stun-usage-ice-conncheck-priority"></a><h3>stun_usage_ice_conncheck_priority ()</h3>
<pre class="programlisting"><span class="returnvalue">uint32_t</span> stun_usage_ice_conncheck_priority (<em class="parameter"><code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>);</pre>
<p>
Extracts the priority from a STUN message.
</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 parse</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>host byte order priority, or 0 if not specified.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="stun-usage-ice-conncheck-use-candidate"></a><h3>stun_usage_ice_conncheck_use_candidate ()</h3>
<pre class="programlisting"><span class="returnvalue">bool</span> stun_usage_ice_conncheck_use_candidate
(<em class="parameter"><code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>);</pre>
<p>
Extracts the USE-CANDIDATE attribute flag from a STUN message.
</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 parse</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the flag is set, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|