← Back to branch summary

~ubuntu-branches/debian/stretch/libnice/stretch

« back to all changes in this revision

Viewing changes to docs/reference/libnice/html/libnice-ICE.html

  • Committer: Package Import Robot
  • Author(s): Simon McVittie
  • Date: 2014-05-14 12:00:13 UTC
  • mfrom: (1.2.9) (5.1.13 sid)
  • Revision ID: package-import@ubuntu.com-20140514120013-fi5mh9bexrjnwnd8
Tags: 0.1.7-1
http://bugs.debian.org/743232
http://bugs.debian.org/743233
* New upstream release 0.1.6, 0.1.7
  - fixes various compiler warnings that were mistakenly fatal in 0.1.5
    (Closes: #743232, #743233)
  - update symbols file for new API
* Explicitly disable -Werror, even if we package a non-release in future
* Don't run tests during the build. We were ignoring failures already,
  and they sometimes hang until the buildd terminates them.
  Upstream (Olivier Crête) says they are stable enough to be useful
  for developers, but not for integration testing.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libnice/html/libnice-ICE.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ICE</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="libnice Reference Manual">
8
8
<link rel="up" href="ch04.html" title="STUN usages">
9
9
<link rel="prev" href="libnice-Bind.html" title="Bind">
10
10
<link rel="next" href="libnice-TURN.html" title="TURN">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
61
61
                                                         <em class="parameter"><code>const <span class="type">char</span> *candidate_identifier</code></em>,
62
62
                                                         <em class="parameter"><code><a class="link" href="libnice-ICE.html#StunUsageIceCompatibility" title="enum StunUsageIceCompatibility"><span class="type">StunUsageIceCompatibility</span></a> compatibility</code></em>);
63
63
<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>,
64
 
                                                         <em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
 
64
                                                         <em class="parameter"><code><span class="type">struct sockaddr_storage</span> *addr</code></em>,
65
65
                                                         <em class="parameter"><code><span class="type">socklen_t</span> *addrlen</code></em>,
66
66
                                                         <em class="parameter"><code><a class="link" href="libnice-ICE.html#StunUsageIceCompatibility" title="enum StunUsageIceCompatibility"><span class="type">StunUsageIceCompatibility</span></a> compatibility</code></em>);
67
67
<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>
70
70
                                                         <em class="parameter"><code><a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>,
71
71
                                                         <em class="parameter"><code><span class="type">uint8_t</span> *buf</code></em>,
72
72
                                                         <em class="parameter"><code><span class="type">size_t</span> *plen</code></em>,
73
 
                                                         <em class="parameter"><code>const <span class="type">struct sockaddr</span> *src</code></em>,
 
73
                                                         <em class="parameter"><code>const <span class="type">struct sockaddr_storage</span> *src</code></em>,
74
74
                                                         <em class="parameter"><code><span class="type">socklen_t</span> srclen</code></em>,
75
75
                                                         <em class="parameter"><code><span class="type">bool</span> *control</code></em>,
76
76
                                                         <em class="parameter"><code><span class="type">uint64_t</span> tie</code></em>,
114
114
</div>
115
115
<p>
116
116
</p>
117
 
<div class="variablelist"><table border="0">
 
117
<div class="variablelist"><table border="0" class="variablelist">
 
118
<colgroup>
118
119
<col align="left" valign="top">
 
120
<col>
 
121
</colgroup>
119
122
<tbody>
120
123
<tr>
121
124
<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>
168
171
<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
169
172
status the function call returned.
170
173
</p>
171
 
<div class="variablelist"><table border="0">
 
174
<div class="variablelist"><table border="0" class="variablelist">
 
175
<colgroup>
172
176
<col align="left" valign="top">
 
177
<col>
 
178
</colgroup>
173
179
<tbody>
174
180
<tr>
175
181
<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>
246
252
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
247
253
<em class="parameter"><code>candidate_identifier</code></em> argument is not used.
248
254
</p>
249
 
<div class="variablelist"><table border="0">
 
255
<div class="variablelist"><table border="0" class="variablelist">
 
256
<colgroup>
250
257
<col align="left" valign="top">
 
258
<col>
 
259
</colgroup>
251
260
<tbody>
252
261
<tr>
253
262
<td><p><span class="term"><em class="parameter"><code>agent</code></em> :</span></p></td>
287
296
</tr>
288
297
<tr>
289
298
<td><p><span class="term"><em class="parameter"><code>cand_use</code></em> :</span></p></td>
290
 
<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>
 
299
<td>Set to <code class="literal">TRUE</code> to append the USE-CANDIDATE flag to the request</td>
291
300
</tr>
292
301
<tr>
293
302
<td><p><span class="term"><em class="parameter"><code>controlling</code></em> :</span></p></td>
294
 
<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
295
 
<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>
 
303
<td>Set to <code class="literal">TRUE</code> if you are the controlling agent or set to
 
304
<code class="literal">FALSE</code> if you are the controlled agent.</td>
296
305
</tr>
297
306
<tr>
298
307
<td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
324
333
<div class="refsect2">
325
334
<a name="stun-usage-ice-conncheck-process"></a><h3>stun_usage_ice_conncheck_process ()</h3>
326
335
<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>,
327
 
                                                         <em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
 
336
                                                         <em class="parameter"><code><span class="type">struct sockaddr_storage</span> *addr</code></em>,
328
337
                                                         <em class="parameter"><code><span class="type">socklen_t</span> *addrlen</code></em>,
329
338
                                                         <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>
330
339
<p>
335
344
<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>
336
345
<p>
337
346
</p>
338
 
<div class="variablelist"><table border="0">
 
347
<div class="variablelist"><table border="0" class="variablelist">
 
348
<colgroup>
339
349
<col align="left" valign="top">
 
350
<col>
 
351
</colgroup>
340
352
<tbody>
341
353
<tr>
342
354
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
373
385
                                                         <em class="parameter"><code><a class="link" href="libnice-StunMessage.html#StunMessage" title="struct StunMessage"><span class="type">StunMessage</span></a> *msg</code></em>,
374
386
                                                         <em class="parameter"><code><span class="type">uint8_t</span> *buf</code></em>,
375
387
                                                         <em class="parameter"><code><span class="type">size_t</span> *plen</code></em>,
376
 
                                                         <em class="parameter"><code>const <span class="type">struct sockaddr</span> *src</code></em>,
 
388
                                                         <em class="parameter"><code>const <span class="type">struct sockaddr_storage</span> *src</code></em>,
377
389
                                                         <em class="parameter"><code><span class="type">socklen_t</span> srclen</code></em>,
378
390
                                                         <em class="parameter"><code><span class="type">bool</span> *control</code></em>,
379
391
                                                         <em class="parameter"><code><span class="type">uint64_t</span> tie</code></em>,
392
404
</div>
393
405
<p>
394
406
</p>
395
 
<div class="variablelist"><table border="0">
 
407
<div class="variablelist"><table border="0" class="variablelist">
 
408
<colgroup>
396
409
<col align="left" valign="top">
 
410
<col>
 
411
</colgroup>
397
412
<tbody>
398
413
<tr>
399
414
<td><p><span class="term"><em class="parameter"><code>agent</code></em> :</span></p></td>
430
445
</tr>
431
446
<tr>
432
447
<td><p><span class="term"><em class="parameter"><code>control</code></em> :</span></p></td>
433
 
<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
434
 
<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>
 
448
<td>Set to <code class="literal">TRUE</code> if you are the controlling agent or set to
 
449
<code class="literal">FALSE</code> if you are the controlled agent.</td>
435
450
</tr>
436
451
<tr>
437
452
<td><p><span class="term"><em class="parameter"><code>tie</code></em> :</span></p></td>
457
472
<p>
458
473
Extracts the priority from a STUN message.
459
474
</p>
460
 
<div class="variablelist"><table border="0">
 
475
<div class="variablelist"><table border="0" class="variablelist">
 
476
<colgroup>
461
477
<col align="left" valign="top">
 
478
<col>
 
479
</colgroup>
462
480
<tbody>
463
481
<tr>
464
482
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
479
497
<p>
480
498
Extracts the USE-CANDIDATE attribute flag from a STUN message.
481
499
</p>
482
 
<div class="variablelist"><table border="0">
 
500
<div class="variablelist"><table border="0" class="variablelist">
 
501
<colgroup>
483
502
<col align="left" valign="top">
 
503
<col>
 
504
</colgroup>
484
505
<tbody>
485
506
<tr>
486
507
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
489
510
<tr>
490
511
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
491
512
<td>
492
 
<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>
 
513
<code class="literal">TRUE</code> if the flag is set, <code class="literal">FALSE</code> if not.</td>
493
514
</tr>
494
515
</tbody>
495
516
</table></div>
498
519
</div>
499
520
<div class="footer">
500
521
<hr>
501
 
          Generated by GTK-Doc V1.18</div>
 
522
          Generated by GTK-Doc V1.19</div>
502
523
</body>
503
524
</html>
 
 
b'\\ No newline at end of file'