libnice-doc 0.1.14-1 / usr / share / gtk-doc / html / libnice / NiceCandidate.html

This file is indexed.

/usr/share/gtk-doc/html/libnice/NiceCandidate.html is in libnice-doc 0.1.14-1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NiceCandidate: libnice Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libnice Reference Manual">
<link rel="up" href="ch01.html" title="">
<link rel="prev" href="libnice-NiceAddress.html" title="NiceAddress">
<link rel="next" href="ch02.html" title="Libnice helper functions">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#NiceCandidate.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#NiceCandidate.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libnice-NiceAddress.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="NiceCandidate"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NiceCandidate.top_of_page"></a>NiceCandidate</span></h2>
<p>NiceCandidate — ICE candidate representation</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="NiceCandidate.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="NiceCandidate.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceCandidate.html#nice-candidate-new" title="nice_candidate_new ()">nice_candidate_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="NiceCandidate.html#nice-candidate-free" title="nice_candidate_free ()">nice_candidate_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
</td>
<td class="function_name">
<a class="link" href="NiceCandidate.html#nice-candidate-copy" title="nice_candidate_copy ()">nice_candidate_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NiceCandidate.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="NiceCandidate.html#NiceCandidate-struct" title="struct NiceCandidate">NiceCandidate</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="NiceCandidate.html#NiceCandidateType" title="enum NiceCandidateType">NiceCandidateType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="NiceCandidate.html#NiceCandidateTransport" title="enum NiceCandidateTransport">NiceCandidateTransport</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="NiceCandidate.html#TurnServer" title="struct TurnServer">TurnServer</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="NiceCandidate.html#NiceRelayType" title="enum NiceRelayType">NiceRelayType</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="NiceCandidate.html#NICE-CANDIDATE-MAX-FOUNDATION:CAPS" title="NICE_CANDIDATE_MAX_FOUNDATION">NICE_CANDIDATE_MAX_FOUNDATION</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NiceCandidate.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/gobject-Boxed-Types.html">GBoxed</a>
    <span class="lineart">╰──</span> NiceCandidate
</pre>
</div>
<div class="refsect1">
<a name="NiceCandidate.description"></a><h2>Description</h2>
<p>A representation of an ICE candidate. Make sure you read the ICE drafts[1] to
understand correctly the concept of ICE candidates.</p>
<p>[1] http://tools.ietf.org/wg/mmusic/draft-ietf-mmusic-ice/</p>
</div>
<div class="refsect1">
<a name="NiceCandidate.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="nice-candidate-new"></a><h3>nice_candidate_new ()</h3>
<pre class="programlisting"><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
nice_candidate_new (<em class="parameter"><code><a class="link" href="NiceCandidate.html#NiceCandidateType" title="enum NiceCandidateType"><span class="type">NiceCandidateType</span></a> type</code></em>);</pre>
<p>Creates a new candidate. Must be freed with <a class="link" href="NiceCandidate.html#nice-candidate-free" title="nice_candidate_free ()"><code class="function">nice_candidate_free()</code></a></p>
<div class="refsect3">
<a name="nice-candidate-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>The <a class="link" href="NiceCandidate.html#NiceCandidateType" title="enum NiceCandidateType"><span class="type">NiceCandidateType</span></a> of the candidate to create</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-candidate-new.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-candidate-free"></a><h3>nice_candidate_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
nice_candidate_free (<em class="parameter"><code><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate</code></em>);</pre>
<p>Frees a <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a></p>
<div class="refsect3">
<a name="nice-candidate-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>candidate</p></td>
<td class="parameter_description"><p>The candidate to free</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nice-candidate-copy"></a><h3>nice_candidate_copy ()</h3>
<pre class="programlisting"><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
nice_candidate_copy (<em class="parameter"><code>const <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate</code></em>);</pre>
<p>Makes a copy of a <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a></p>
<div class="refsect3">
<a name="nice-candidate-copy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>candidate</p></td>
<td class="parameter_description"><p>The candidate to copy</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nice-candidate-copy.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a>, a copy of <em class="parameter"><code>candidate</code></em>
</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="NiceCandidate.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="NiceCandidate-struct"></a><h3>struct NiceCandidate</h3>
<pre class="programlisting">struct NiceCandidate {
  NiceCandidateType type;
  NiceCandidateTransport transport;
  NiceAddress addr;
  NiceAddress base_addr;
  guint32 priority;
  guint stream_id;
  guint component_id;
  gchar foundation[NICE_CANDIDATE_MAX_FOUNDATION];
  gchar *username;        /* pointer to a nul-terminated username string */
  gchar *password;        /* pointer to a nul-terminated password string */
  TurnServer *turn;
  gpointer sockptr;
};
</pre>
<p>A structure to represent an ICE candidate</p>
<div class="note"><p>
   The <em class="parameter"><code>priority</code></em> is an integer as specified in the ICE draft 19. If you are
   using the MSN or the GOOGLE compatibility mode (which are based on ICE
   draft 6, which uses a floating point qvalue as priority), then the <em class="parameter"><code>priority</code></em>
   value will represent the qvalue multiplied by 1000.
   </p></div>
<div class="refsect3">
<a name="NiceCandidate.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="NiceCandidate.html#NiceCandidateType" title="enum NiceCandidateType"><span class="type">NiceCandidateType</span></a> <em class="structfield"><code><a name="NiceCandidate-struct.type"></a>type</code></em>;</p></td>
<td class="struct_member_description"><p>The type of candidate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="NiceCandidate.html#NiceCandidateTransport" title="enum NiceCandidateTransport"><span class="type">NiceCandidateTransport</span></a> <em class="structfield"><code><a name="NiceCandidate-struct.transport"></a>transport</code></em>;</p></td>
<td class="struct_member_description"><p>The transport being used for the candidate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> <em class="structfield"><code><a name="NiceCandidate-struct.addr"></a>addr</code></em>;</p></td>
<td class="struct_member_description"><p>The <a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> of the candidate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> <em class="structfield"><code><a name="NiceCandidate-struct.base-addr"></a>base_addr</code></em>;</p></td>
<td class="struct_member_description"><p>The <a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> of the base address used by the candidate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="NiceCandidate-struct.priority"></a>priority</code></em>;</p></td>
<td class="struct_member_description"><p>The priority of the candidate <span class="emphasis"><em> see note </em></span></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="NiceCandidate-struct.stream-id"></a>stream_id</code></em>;</p></td>
<td class="struct_member_description"><p>The ID of the stream to which belongs the candidate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="NiceCandidate-struct.component-id"></a>component_id</code></em>;</p></td>
<td class="struct_member_description"><p>The ID of the component to which belongs the candidate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> <em class="structfield"><code><a name="NiceCandidate-struct.foundation"></a>foundation</code></em>[NICE_CANDIDATE_MAX_FOUNDATION];</p></td>
<td class="struct_member_description"><p>The foundation of the candidate</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="NiceCandidate-struct.username"></a>username</code></em>;</p></td>
<td class="struct_member_description"><p>The candidate-specific username to use (overrides the one set
by <a class="link" href="NiceAgent.html#nice-agent-set-local-credentials" title="nice_agent_set_local_credentials ()"><code class="function">nice_agent_set_local_credentials()</code></a> or <a class="link" href="NiceAgent.html#nice-agent-set-remote-credentials" title="nice_agent_set_remote_credentials ()"><code class="function">nice_agent_set_remote_credentials()</code></a>)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="NiceCandidate-struct.password"></a>password</code></em>;</p></td>
<td class="struct_member_description"><p>The candidate-specific password to use (overrides the one set
by <a class="link" href="NiceAgent.html#nice-agent-set-local-credentials" title="nice_agent_set_local_credentials ()"><code class="function">nice_agent_set_local_credentials()</code></a> or <a class="link" href="NiceAgent.html#nice-agent-set-remote-credentials" title="nice_agent_set_remote_credentials ()"><code class="function">nice_agent_set_remote_credentials()</code></a>)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="NiceCandidate.html#TurnServer" title="struct TurnServer"><span class="type">TurnServer</span></a> *<em class="structfield"><code><a name="NiceCandidate-struct.turn"></a>turn</code></em>;</p></td>
<td class="struct_member_description"><p>The <a class="link" href="NiceCandidate.html#TurnServer" title="struct TurnServer"><span class="type">TurnServer</span></a> settings if the candidate is
of type <a class="link" href="NiceCandidate.html#NICE-CANDIDATE-TYPE-RELAYED:CAPS"><code class="literal">NICE_CANDIDATE_TYPE_RELAYED</code></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="NiceCandidate-struct.sockptr"></a>sockptr</code></em>;</p></td>
<td class="struct_member_description"><p>The underlying socket</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="NiceCandidateType"></a><h3>enum NiceCandidateType</h3>
<p>An enum represneting the type of a candidate</p>
<div class="refsect3">
<a name="NiceCandidateType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="NICE-CANDIDATE-TYPE-HOST:CAPS"></a>NICE_CANDIDATE_TYPE_HOST</p></td>
<td class="enum_member_description">
<p>A host candidate</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-CANDIDATE-TYPE-SERVER-REFLEXIVE:CAPS"></a>NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE</p></td>
<td class="enum_member_description">
<p>A server reflexive candidate</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-CANDIDATE-TYPE-PEER-REFLEXIVE:CAPS"></a>NICE_CANDIDATE_TYPE_PEER_REFLEXIVE</p></td>
<td class="enum_member_description">
<p>A peer reflexive candidate</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-CANDIDATE-TYPE-RELAYED:CAPS"></a>NICE_CANDIDATE_TYPE_RELAYED</p></td>
<td class="enum_member_description">
<p>A relay candidate</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="NiceCandidateTransport"></a><h3>enum NiceCandidateTransport</h3>
<p>An enum representing the type of transport to use</p>
<div class="refsect3">
<a name="NiceCandidateTransport.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="NICE-CANDIDATE-TRANSPORT-UDP:CAPS"></a>NICE_CANDIDATE_TRANSPORT_UDP</p></td>
<td class="enum_member_description">
<p>UDP transport</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-CANDIDATE-TRANSPORT-TCP-ACTIVE:CAPS"></a>NICE_CANDIDATE_TRANSPORT_TCP_ACTIVE</p></td>
<td class="enum_member_description">
<p>TCP Active transport</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-CANDIDATE-TRANSPORT-TCP-PASSIVE:CAPS"></a>NICE_CANDIDATE_TRANSPORT_TCP_PASSIVE</p></td>
<td class="enum_member_description">
<p>TCP Passive transport</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-CANDIDATE-TRANSPORT-TCP-SO:CAPS"></a>NICE_CANDIDATE_TRANSPORT_TCP_SO</p></td>
<td class="enum_member_description">
<p>TCP Simultaneous-Open transport</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="TurnServer"></a><h3>struct TurnServer</h3>
<pre class="programlisting">struct TurnServer {
  gint ref_count;

  NiceAddress server;
  gchar *username;
  gchar *password;
  NiceRelayType type;
};
</pre>
<p>A structure to store the TURN relay settings</p>
<div class="refsect3">
<a name="TurnServer.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="TurnServer.ref-count"></a>ref_count</code></em>;</p></td>
<td class="struct_member_description"><p>Reference count for the structure.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> <em class="structfield"><code><a name="TurnServer.server"></a>server</code></em>;</p></td>
<td class="struct_member_description"><p>The <a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> of the TURN server</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TurnServer.username"></a>username</code></em>;</p></td>
<td class="struct_member_description"><p>The TURN username</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TurnServer.password"></a>password</code></em>;</p></td>
<td class="struct_member_description"><p>The TURN password</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="NiceCandidate.html#NiceRelayType" title="enum NiceRelayType"><span class="type">NiceRelayType</span></a> <em class="structfield"><code><a name="TurnServer.type"></a>type</code></em>;</p></td>
<td class="struct_member_description"><p>The <a class="link" href="NiceCandidate.html#NiceRelayType" title="enum NiceRelayType"><span class="type">NiceRelayType</span></a> of the server</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="NiceRelayType"></a><h3>enum NiceRelayType</h3>
<p>An enum representing the type of relay to use</p>
<div class="refsect3">
<a name="NiceRelayType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="NICE-RELAY-TYPE-TURN-UDP:CAPS"></a>NICE_RELAY_TYPE_TURN_UDP</p></td>
<td class="enum_member_description">
<p>A TURN relay using UDP</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-RELAY-TYPE-TURN-TCP:CAPS"></a>NICE_RELAY_TYPE_TURN_TCP</p></td>
<td class="enum_member_description">
<p>A TURN relay using TCP</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="NICE-RELAY-TYPE-TURN-TLS:CAPS"></a>NICE_RELAY_TYPE_TURN_TLS</p></td>
<td class="enum_member_description">
<p>A TURN relay using TLS over TCP</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="NICE-CANDIDATE-MAX-FOUNDATION:CAPS"></a><h3>NICE_CANDIDATE_MAX_FOUNDATION</h3>
<pre class="programlisting">#define NICE_CANDIDATE_MAX_FOUNDATION                (32+1)
</pre>
<p>The maximum size a candidate foundation can have.</p>
</div>
</div>
<div class="refsect1">
<a name="NiceCandidate.see-also"></a><h2>See Also</h2>
<p><a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.