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

This file is indexed.

/usr/share/gtk-doc/html/libnice/libnice-NiceCandidate.html is in libnice-doc 0.1.4-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
<!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</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="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.18 (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-NiceAddress.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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="ch02.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-NiceCandidate.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libnice-NiceCandidate.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libnice-NiceCandidate"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libnice-NiceCandidate.top_of_page"></a>NiceCandidate</span></h2>
<p>NiceCandidate — ICE candidate representation</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libnice-NiceCandidate.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libnice-NiceCandidate.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate">NiceCandidate</a>;
enum                <a class="link" href="libnice-NiceCandidate.html#NiceCandidateType" title="enum NiceCandidateType">NiceCandidateType</a>;
enum                <a class="link" href="libnice-NiceCandidate.html#NiceCandidateTransport" title="enum NiceCandidateTransport">NiceCandidateTransport</a>;
struct              <a class="link" href="libnice-NiceCandidate.html#TurnServer" title="struct TurnServer">TurnServer</a>;
enum                <a class="link" href="libnice-NiceCandidate.html#NiceRelayType" title="enum NiceRelayType">NiceRelayType</a>;
#define             <a class="link" href="libnice-NiceCandidate.html#NICE-CANDIDATE-MAX-FOUNDATION:CAPS" title="NICE_CANDIDATE_MAX_FOUNDATION">NICE_CANDIDATE_MAX_FOUNDATION</a>
<a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *     <a class="link" href="libnice-NiceCandidate.html#nice-candidate-new" title="nice_candidate_new ()">nice_candidate_new</a>                  (<em class="parameter"><code><a class="link" href="libnice-NiceCandidate.html#NiceCandidateType" title="enum NiceCandidateType"><span class="type">NiceCandidateType</span></a> type</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libnice-NiceCandidate.html#nice-candidate-free" title="nice_candidate_free ()">nice_candidate_free</a>                 (<em class="parameter"><code><a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate</code></em>);
<a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *     <a class="link" href="libnice-NiceCandidate.html#nice-candidate-copy" title="nice_candidate_copy ()">nice_candidate_copy</a>                 (<em class="parameter"><code>const <a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libnice-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="libnice-NiceCandidate.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="NiceCandidate"></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 NULL-terminated username string */
  gchar *password;        /* pointer to a NULL-terminated password string */
  TurnServer *turn;
  gpointer sockptr;
};
</pre>
<p>
A structure to represent an ICE candidate
 </p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a class="link" href="libnice-NiceCandidate.html#NiceCandidateType" title="enum NiceCandidateType"><span class="type">NiceCandidateType</span></a> <em class="structfield"><code><a name="NiceCandidate.type"></a>type</code></em>;</span></p></td>
<td>The type of candidate</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libnice-NiceCandidate.html#NiceCandidateTransport" title="enum NiceCandidateTransport"><span class="type">NiceCandidateTransport</span></a> <em class="structfield"><code><a name="NiceCandidate.transport"></a>transport</code></em>;</span></p></td>
<td>The transport being used for the candidate</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> <em class="structfield"><code><a name="NiceCandidate.addr"></a>addr</code></em>;</span></p></td>
<td>The <a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> of the candidate</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> <em class="structfield"><code><a name="NiceCandidate.base-addr"></a>base_addr</code></em>;</span></p></td>
<td>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</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> <em class="structfield"><code><a name="NiceCandidate.priority"></a>priority</code></em>;</span></p></td>
<td>The priority of the candidate <span class="emphasis"><em> see note </em></span>
</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="NiceCandidate.stream-id"></a>stream_id</code></em>;</span></p></td>
<td>The ID of the stream to which belongs the candidate</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="NiceCandidate.component-id"></a>component_id</code></em>;</span></p></td>
<td>The ID of the component to which belongs the candidate</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> <em class="structfield"><code><a name="NiceCandidate.foundation"></a>foundation</code></em>[NICE_CANDIDATE_MAX_FOUNDATION];</span></p></td>
<td>The foundation of the candidate</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="NiceCandidate.username"></a>username</code></em>;</span></p></td>
<td>The candidate-specific username to use (overrides the one set
by <code class="function">nice_agent_set_local_credentials()</code> 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>)</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="NiceCandidate.password"></a>password</code></em>;</span></p></td>
<td>The candidate-specific password to use (overrides the one set
by <code class="function">nice_agent_set_local_credentials()</code> 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>)</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libnice-NiceCandidate.html#TurnServer" title="struct TurnServer"><span class="type">TurnServer</span></a> *<em class="structfield"><code><a name="NiceCandidate.turn"></a>turn</code></em>;</span></p></td>
<td>The <a class="link" href="libnice-NiceCandidate.html#TurnServer" title="struct TurnServer"><span class="type">TurnServer</span></a> settings if the candidate is
of type <a class="link" href="libnice-NiceCandidate.html#NICE-CANDIDATE-TYPE-RELAYED:CAPS"><code class="literal">NICE_CANDIDATE_TYPE_RELAYED</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="NiceCandidate.sockptr"></a>sockptr</code></em>;</span></p></td>
<td>The underlying socket</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="NiceCandidateType"></a><h3>enum NiceCandidateType</h3>
<pre class="programlisting">typedef enum {
  NICE_CANDIDATE_TYPE_HOST,
  NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE,
  NICE_CANDIDATE_TYPE_PEER_REFLEXIVE,
  NICE_CANDIDATE_TYPE_RELAYED,
} NiceCandidateType;
</pre>
<p>
An enum represneting the type of a candidate
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="NICE-CANDIDATE-TYPE-HOST:CAPS"></a><span class="term"><code class="literal">NICE_CANDIDATE_TYPE_HOST</code></span></p></td>
<td>A host candidate
</td>
</tr>
<tr>
<td><p><a name="NICE-CANDIDATE-TYPE-SERVER-REFLEXIVE:CAPS"></a><span class="term"><code class="literal">NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE</code></span></p></td>
<td>A server reflexive candidate
</td>
</tr>
<tr>
<td><p><a name="NICE-CANDIDATE-TYPE-PEER-REFLEXIVE:CAPS"></a><span class="term"><code class="literal">NICE_CANDIDATE_TYPE_PEER_REFLEXIVE</code></span></p></td>
<td>A peer reflexive candidate
</td>
</tr>
<tr>
<td><p><a name="NICE-CANDIDATE-TYPE-RELAYED:CAPS"></a><span class="term"><code class="literal">NICE_CANDIDATE_TYPE_RELAYED</code></span></p></td>
<td>A relay candidate
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="NiceCandidateTransport"></a><h3>enum NiceCandidateTransport</h3>
<pre class="programlisting">typedef enum {
  NICE_CANDIDATE_TRANSPORT_UDP,
} NiceCandidateTransport;
</pre>
<p>
An enum representing the type of transport to use
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><a name="NICE-CANDIDATE-TRANSPORT-UDP:CAPS"></a><span class="term"><code class="literal">NICE_CANDIDATE_TRANSPORT_UDP</code></span></p></td>
<td>UDP transport
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="TurnServer"></a><h3>struct TurnServer</h3>
<pre class="programlisting">struct TurnServer {
  NiceAddress server;       /**&lt; TURN server address */
  gchar *username;           /**&lt; TURN username */
  gchar *password;           /**&lt; TURN password */
  NiceRelayType type;             /**&lt; TURN type */
};
</pre>
<p>
A structure to store the TURN relay settings
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><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>;</span></p></td>
<td>The <a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a> of the TURN server</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TurnServer.username"></a>username</code></em>;</span></p></td>
<td>The TURN username</td>
</tr>
<tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TurnServer.password"></a>password</code></em>;</span></p></td>
<td>The TURN password</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libnice-NiceCandidate.html#NiceRelayType" title="enum NiceRelayType"><span class="type">NiceRelayType</span></a> <em class="structfield"><code><a name="TurnServer.type"></a>type</code></em>;</span></p></td>
<td>The <a class="link" href="libnice-NiceCandidate.html#NiceRelayType" title="enum NiceRelayType"><span class="type">NiceRelayType</span></a> of the server</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="NiceRelayType"></a><h3>enum NiceRelayType</h3>
<pre class="programlisting">typedef enum {
  NICE_RELAY_TYPE_TURN_UDP,
  NICE_RELAY_TYPE_TURN_TCP,
  NICE_RELAY_TYPE_TURN_TLS
} NiceRelayType;
</pre>
<p>
An enum representing the type of relay to use
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="NICE-RELAY-TYPE-TURN-UDP:CAPS"></a><span class="term"><code class="literal">NICE_RELAY_TYPE_TURN_UDP</code></span></p></td>
<td>A TURN relay using UDP
</td>
</tr>
<tr>
<td><p><a name="NICE-RELAY-TYPE-TURN-TCP:CAPS"></a><span class="term"><code class="literal">NICE_RELAY_TYPE_TURN_TCP</code></span></p></td>
<td>A TURN relay using TCP
</td>
</tr>
<tr>
<td><p><a name="NICE-RELAY-TYPE-TURN-TLS:CAPS"></a><span class="term"><code class="literal">NICE_RELAY_TYPE_TURN_TLS</code></span></p></td>
<td>A TURN relay using TLS over TCP
</td>
</tr>
</tbody>
</table></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>
<hr>
<div class="refsect2">
<a name="nice-candidate-new"></a><h3>nice_candidate_new ()</h3>
<pre class="programlisting"><a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *     nice_candidate_new                  (<em class="parameter"><code><a class="link" href="libnice-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="libnice-NiceCandidate.html#nice-candidate-free" title="nice_candidate_free ()"><code class="function">nice_candidate_free()</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>The <a class="link" href="libnice-NiceCandidate.html#NiceCandidateType" title="enum NiceCandidateType"><span class="type">NiceCandidateType</span></a> of the candidate to create</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="type">NiceCandidate</span></a>
</td>
</tr>
</tbody>
</table></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="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate</code></em>);</pre>
<p>
Frees a <a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="type">NiceCandidate</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>candidate</code></em> :</span></p></td>
<td>The candidate to free</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="nice-candidate-copy"></a><h3>nice_candidate_copy ()</h3>
<pre class="programlisting"><a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *     nice_candidate_copy                 (<em class="parameter"><code>const <a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate</code></em>);</pre>
<p>
Makes a copy of a <a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="type">NiceCandidate</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>candidate</code></em> :</span></p></td>
<td>The candidate to copy</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="libnice-NiceCandidate.html#NiceCandidate" title="struct NiceCandidate"><span class="type">NiceCandidate</span></a>, a copy of <em class="parameter"><code>candidate</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libnice-NiceCandidate.see-also"></a><h2>See Also</h2>
<a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.