docs/reference/libnice/html/NiceCandidate.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>NiceCandidate: libnice Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
   7 <link rel="home" href="index.html" title="libnice Reference Manual">
   8 <link rel="up" href="ch01.html" title="">
   9 <link rel="prev" href="libnice-NiceAddress.html" title="NiceAddress">
  10 <link rel="next" href="ch02.html" title="Libnice helper functions">
  11 <meta name="generator" content="GTK-Doc V1.29 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#NiceCandidate.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#NiceCandidate.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="libnice-NiceAddress.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="NiceCandidate"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="NiceCandidate.top_of_page"></a>NiceCandidate</span></h2>
  31 <p>NiceCandidate — ICE candidate representation</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="NiceCandidate.stability-level"></a><h2>Stability Level</h2>
  37 <acronym title="The intention of a Stable interface is to enable arbitrary third parties to
  38 develop applications to these interfaces, release them, and have confidence that
  39 they will run on all minor releases of the product (after the one in which the
  40 interface was introduced, and within the same major release). Even at a major
  41 release, incompatible changes are expected to be rare, and to have strong
  42 justifications.
  43 "><span class="acronym">Stable</span></acronym>, unless otherwise indicated
  44 </div>
  45 <div class="refsect1">
  46 <a name="NiceCandidate.functions"></a><h2>Functions</h2>
  47 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  48 <colgroup>
  49 <col width="150px" class="functions_return">
  50 <col class="functions_name">
  51 </colgroup>
  52 <tbody>
  53 <tr>
  54 <td class="function_type">
  55 <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
  56 </td>
  57 <td class="function_name">
  58 <a class="link" href="NiceCandidate.html#nice-candidate-new" title="nice_candidate_new ()">nice_candidate_new</a> <span class="c_punctuation">()</span>
  59 </td>
  60 </tr>
  61 <tr>
  62 <td class="function_type">
  63 <span class="returnvalue">void</span>
  64 </td>
  65 <td class="function_name">
  66 <a class="link" href="NiceCandidate.html#nice-candidate-free" title="nice_candidate_free ()">nice_candidate_free</a> <span class="c_punctuation">()</span>
  67 </td>
  68 </tr>
  69 <tr>
  70 <td class="function_type">
  71 <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
  72 </td>
  73 <td class="function_name">
  74 <a class="link" href="NiceCandidate.html#nice-candidate-copy" title="nice_candidate_copy ()">nice_candidate_copy</a> <span class="c_punctuation">()</span>
  75 </td>
  76 </tr>
  77 <tr>
  78 <td class="function_type">
  79 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  80 </td>
  81 <td class="function_name">
  82 <a class="link" href="NiceCandidate.html#nice-candidate-equal-target" title="nice_candidate_equal_target ()">nice_candidate_equal_target</a> <span class="c_punctuation">()</span>
  83 </td>
  84 </tr>
  85 </tbody>
  86 </table></div>
  87 </div>
  88 <div class="refsect1">
  89 <a name="NiceCandidate.other"></a><h2>Types and Values</h2>
  90 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  91 <colgroup>
  92 <col width="150px" class="name">
  93 <col class="description">
  94 </colgroup>
  95 <tbody>
  96 <tr>
  97 <td class="datatype_keyword">struct</td>
  98 <td class="function_name"><a class="link" href="NiceCandidate.html#NiceCandidate-struct" title="struct NiceCandidate">NiceCandidate</a></td>
  99 </tr>
 100 <tr>
 101 <td class="datatype_keyword">enum</td>
 102 <td class="function_name"><a class="link" href="NiceCandidate.html#NiceCandidateType" title="enum NiceCandidateType">NiceCandidateType</a></td>
 103 </tr>
 104 <tr>
 105 <td class="datatype_keyword">enum</td>
 106 <td class="function_name"><a class="link" href="NiceCandidate.html#NiceCandidateTransport" title="enum NiceCandidateTransport">NiceCandidateTransport</a></td>
 107 </tr>
 108 <tr>
 109 <td class="datatype_keyword">struct</td>
 110 <td class="function_name"><a class="link" href="NiceCandidate.html#TurnServer" title="struct TurnServer">TurnServer</a></td>
 111 </tr>
 112 <tr>
 113 <td class="datatype_keyword">enum</td>
 114 <td class="function_name"><a class="link" href="NiceCandidate.html#NiceRelayType" title="enum NiceRelayType">NiceRelayType</a></td>
 115 </tr>
 116 <tr>
 117 <td class="define_keyword">#define</td>
 118 <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>
 119 </tr>
 120 </tbody>
 121 </table></div>
 122 </div>
 123 <div class="refsect1">
 124 <a name="NiceCandidate.object-hierarchy"></a><h2>Object Hierarchy</h2>
 125 <pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
 126     <span class="lineart">╰──</span> NiceCandidate
 127     <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
 128     <span class="lineart">├──</span> NiceCandidateTransport
 129     <span class="lineart">├──</span> NiceCandidateType
 130     <span class="lineart">╰──</span> NiceRelayType
 131 </pre>
 132 </div>
 133 <div class="refsect1">
 134 <a name="NiceCandidate.description"></a><h2>Description</h2>
 135 <p>A representation of an ICE candidate. Make sure you read the ICE drafts[1] to
 136 understand correctly the concept of ICE candidates.</p>
 137 <p>[1] http://tools.ietf.org/wg/mmusic/draft-ietf-mmusic-ice/</p>
 138 </div>
 139 <div class="refsect1">
 140 <a name="NiceCandidate.functions_details"></a><h2>Functions</h2>
 141 <div class="refsect2">
 142 <a name="nice-candidate-new"></a><h3>nice_candidate_new ()</h3>
 143 <pre class="programlisting"><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
 144 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>
 145 <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>
 146 <div class="refsect3">
 147 <a name="nice-candidate-new.parameters"></a><h4>Parameters</h4>
 148 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 149 <colgroup>
 150 <col width="150px" class="parameters_name">
 151 <col class="parameters_description">
 152 <col width="200px" class="parameters_annotations">
 153 </colgroup>
 154 <tbody><tr>
 155 <td class="parameter_name"><p>type</p></td>
 156 <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>
 157 <td class="parameter_annotations"> </td>
 158 </tr></tbody>
 159 </table></div>
 160 </div>
 161 <div class="refsect3">
 162 <a name="nice-candidate-new.returns"></a><h4>Returns</h4>
 163 <p> A new <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a></p>
 164 </div>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="nice-candidate-free"></a><h3>nice_candidate_free ()</h3>
 169 <pre class="programlisting"><span class="returnvalue">void</span>
 170 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>
 171 <p>Frees a <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a></p>
 172 <div class="refsect3">
 173 <a name="nice-candidate-free.parameters"></a><h4>Parameters</h4>
 174 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 175 <colgroup>
 176 <col width="150px" class="parameters_name">
 177 <col class="parameters_description">
 178 <col width="200px" class="parameters_annotations">
 179 </colgroup>
 180 <tbody><tr>
 181 <td class="parameter_name"><p>candidate</p></td>
 182 <td class="parameter_description"><p>The candidate to free</p></td>
 183 <td class="parameter_annotations"> </td>
 184 </tr></tbody>
 185 </table></div>
 186 </div>
 187 </div>
 188 <hr>
 189 <div class="refsect2">
 190 <a name="nice-candidate-copy"></a><h3>nice_candidate_copy ()</h3>
 191 <pre class="programlisting"><a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="returnvalue">NiceCandidate</span></a> *
 192 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>
 193 <p>Makes a copy of a <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a></p>
 194 <div class="refsect3">
 195 <a name="nice-candidate-copy.parameters"></a><h4>Parameters</h4>
 196 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 197 <colgroup>
 198 <col width="150px" class="parameters_name">
 199 <col class="parameters_description">
 200 <col width="200px" class="parameters_annotations">
 201 </colgroup>
 202 <tbody><tr>
 203 <td class="parameter_name"><p>candidate</p></td>
 204 <td class="parameter_description"><p>The candidate to copy</p></td>
 205 <td class="parameter_annotations"> </td>
 206 </tr></tbody>
 207 </table></div>
 208 </div>
 209 <div class="refsect3">
 210 <a name="nice-candidate-copy.returns"></a><h4>Returns</h4>
 211 <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>
 212 </p>
 213 </div>
 214 </div>
 215 <hr>
 216 <div class="refsect2">
 217 <a name="nice-candidate-equal-target"></a><h3>nice_candidate_equal_target ()</h3>
 218 <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 219 nice_candidate_equal_target (<em class="parameter"><code>const <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate1</code></em>,
 220                              <em class="parameter"><code>const <a class="link" href="NiceCandidate.html" title="NiceCandidate"><span class="type">NiceCandidate</span></a> *candidate2</code></em>);</pre>
 221 <p>Verifies that the candidates point to the same place, meaning they have
 222 the same transport and the same address. It ignores all other aspects.</p>
 223 <div class="refsect3">
 224 <a name="nice-candidate-equal-target.parameters"></a><h4>Parameters</h4>
 225 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 226 <colgroup>
 227 <col width="150px" class="parameters_name">
 228 <col class="parameters_description">
 229 <col width="200px" class="parameters_annotations">
 230 </colgroup>
 231 <tbody>
 232 <tr>
 233 <td class="parameter_name"><p>candidate1</p></td>
 234 <td class="parameter_description"><p>A candidate</p></td>
 235 <td class="parameter_annotations"> </td>
 236 </tr>
 237 <tr>
 238 <td class="parameter_name"><p>candidate2</p></td>
 239 <td class="parameter_description"><p>A candidate</p></td>
 240 <td class="parameter_annotations"> </td>
 241 </tr>
 242 </tbody>
 243 </table></div>
 244 </div>
 245 <div class="refsect3">
 246 <a name="nice-candidate-equal-target.returns"></a><h4>Returns</h4>
 247 <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the candidates point to the same place</p>
 248 </div>
 249 <p class="since">Since: <a class="link" href="ix14.html#api-index-0.1.15">0.1.15</a></p>
 250 </div>
 251 </div>
 252 <div class="refsect1">
 253 <a name="NiceCandidate.other_details"></a><h2>Types and Values</h2>
 254 <div class="refsect2">
 255 <a name="NiceCandidate-struct"></a><h3>struct NiceCandidate</h3>
 256 <pre class="programlisting">struct NiceCandidate {
 257   NiceCandidateType type;
 258   NiceCandidateTransport transport;
 259   NiceAddress addr;
 260   NiceAddress base_addr;
 261   guint32 priority;
 262   guint stream_id;
 263   guint component_id;
 264   gchar foundation[NICE_CANDIDATE_MAX_FOUNDATION];
 265   gchar *username;        /* pointer to a nul-terminated username string */
 266   gchar *password;        /* pointer to a nul-terminated password string */
 267   TurnServer *turn;
 268   gpointer sockptr;
 269 };
 270 </pre>
 271 <p>A structure to represent an ICE candidate</p>
 272 <div class="note"><p>
 273    The <em class="parameter"><code>priority</code></em> is an integer as specified in the ICE draft 19. If you are
 274    using the MSN or the GOOGLE compatibility mode (which are based on ICE
 275    draft 6, which uses a floating point qvalue as priority), then the <em class="parameter"><code>priority</code></em>
 276    value will represent the qvalue multiplied by 1000.
 277    </p></div>
 278 <div class="refsect3">
 279 <a name="NiceCandidate.members"></a><h4>Members</h4>
 280 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 281 <colgroup>
 282 <col width="300px" class="struct_members_name">
 283 <col class="struct_members_description">
 284 <col width="200px" class="struct_members_annotations">
 285 </colgroup>
 286 <tbody>
 287 <tr>
 288 <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>
 289 <td class="struct_member_description"><p>The type of candidate</p></td>
 290 <td class="struct_member_annotations"> </td>
 291 </tr>
 292 <tr>
 293 <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>
 294 <td class="struct_member_description"><p>The transport being used for the candidate</p></td>
 295 <td class="struct_member_annotations"> </td>
 296 </tr>
 297 <tr>
 298 <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>
 299 <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>
 300 <td class="struct_member_annotations"> </td>
 301 </tr>
 302 <tr>
 303 <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>
 304 <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>
 305 <td class="struct_member_annotations"> </td>
 306 </tr>
 307 <tr>
 308 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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>
 309 <td class="struct_member_description"><p>The priority of the candidate <span class="emphasis"><em> see note </em></span></p></td>
 310 <td class="struct_member_annotations"> </td>
 311 </tr>
 312 <tr>
 313 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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>
 314 <td class="struct_member_description"><p>The ID of the stream to which belongs the candidate</p></td>
 315 <td class="struct_member_annotations"> </td>
 316 </tr>
 317 <tr>
 318 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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>
 319 <td class="struct_member_description"><p>The ID of the component to which belongs the candidate</p></td>
 320 <td class="struct_member_annotations"> </td>
 321 </tr>
 322 <tr>
 323 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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>
 324 <td class="struct_member_description"><p>The foundation of the candidate</p></td>
 325 <td class="struct_member_annotations"> </td>
 326 </tr>
 327 <tr>
 328 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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>
 329 <td class="struct_member_description"><p>The candidate-specific username to use (overrides the one set
 330 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>
 331 <td class="struct_member_annotations"> </td>
 332 </tr>
 333 <tr>
 334 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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>
 335 <td class="struct_member_description"><p>The candidate-specific password to use (overrides the one set
 336 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>
 337 <td class="struct_member_annotations"> </td>
 338 </tr>
 339 <tr>
 340 <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>
 341 <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
 342 of type <a class="link" href="NiceCandidate.html#NICE-CANDIDATE-TYPE-RELAYED:CAPS"><code class="literal">NICE_CANDIDATE_TYPE_RELAYED</code></a></p></td>
 343 <td class="struct_member_annotations"> </td>
 344 </tr>
 345 <tr>
 346 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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>
 347 <td class="struct_member_description"><p>The underlying socket</p></td>
 348 <td class="struct_member_annotations"> </td>
 349 </tr>
 350 </tbody>
 351 </table></div>
 352 </div>
 353 </div>
 354 <hr>
 355 <div class="refsect2">
 356 <a name="NiceCandidateType"></a><h3>enum NiceCandidateType</h3>
 357 <p>An enum represneting the type of a candidate</p>
 358 <div class="refsect3">
 359 <a name="NiceCandidateType.members"></a><h4>Members</h4>
 360 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 361 <colgroup>
 362 <col width="300px" class="enum_members_name">
 363 <col class="enum_members_description">
 364 <col width="200px" class="enum_members_annotations">
 365 </colgroup>
 366 <tbody>
 367 <tr>
 368 <td class="enum_member_name"><p><a name="NICE-CANDIDATE-TYPE-HOST:CAPS"></a>NICE_CANDIDATE_TYPE_HOST</p></td>
 369 <td class="enum_member_description">
 370 <p>A host candidate</p>
 371 </td>
 372 <td class="enum_member_annotations"> </td>
 373 </tr>
 374 <tr>
 375 <td class="enum_member_name"><p><a name="NICE-CANDIDATE-TYPE-SERVER-REFLEXIVE:CAPS"></a>NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE</p></td>
 376 <td class="enum_member_description">
 377 <p>A server reflexive candidate</p>
 378 </td>
 379 <td class="enum_member_annotations"> </td>
 380 </tr>
 381 <tr>
 382 <td class="enum_member_name"><p><a name="NICE-CANDIDATE-TYPE-PEER-REFLEXIVE:CAPS"></a>NICE_CANDIDATE_TYPE_PEER_REFLEXIVE</p></td>
 383 <td class="enum_member_description">
 384 <p>A peer reflexive candidate</p>
 385 </td>
 386 <td class="enum_member_annotations"> </td>
 387 </tr>
 388 <tr>
 389 <td class="enum_member_name"><p><a name="NICE-CANDIDATE-TYPE-RELAYED:CAPS"></a>NICE_CANDIDATE_TYPE_RELAYED</p></td>
 390 <td class="enum_member_description">
 391 <p>A relay candidate</p>
 392 </td>
 393 <td class="enum_member_annotations"> </td>
 394 </tr>
 395 </tbody>
 396 </table></div>
 397 </div>
 398 </div>
 399 <hr>
 400 <div class="refsect2">
 401 <a name="NiceCandidateTransport"></a><h3>enum NiceCandidateTransport</h3>
 402 <p>An enum representing the type of transport to use</p>
 403 <div class="refsect3">
 404 <a name="NiceCandidateTransport.members"></a><h4>Members</h4>
 405 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 406 <colgroup>
 407 <col width="300px" class="enum_members_name">
 408 <col class="enum_members_description">
 409 <col width="200px" class="enum_members_annotations">
 410 </colgroup>
 411 <tbody>
 412 <tr>
 413 <td class="enum_member_name"><p><a name="NICE-CANDIDATE-TRANSPORT-UDP:CAPS"></a>NICE_CANDIDATE_TRANSPORT_UDP</p></td>
 414 <td class="enum_member_description">
 415 <p>UDP transport</p>
 416 </td>
 417 <td class="enum_member_annotations"> </td>
 418 </tr>
 419 <tr>
 420 <td class="enum_member_name"><p><a name="NICE-CANDIDATE-TRANSPORT-TCP-ACTIVE:CAPS"></a>NICE_CANDIDATE_TRANSPORT_TCP_ACTIVE</p></td>
 421 <td class="enum_member_description">
 422 <p>TCP Active transport</p>
 423 </td>
 424 <td class="enum_member_annotations"> </td>
 425 </tr>
 426 <tr>
 427 <td class="enum_member_name"><p><a name="NICE-CANDIDATE-TRANSPORT-TCP-PASSIVE:CAPS"></a>NICE_CANDIDATE_TRANSPORT_TCP_PASSIVE</p></td>
 428 <td class="enum_member_description">
 429 <p>TCP Passive transport</p>
 430 </td>
 431 <td class="enum_member_annotations"> </td>
 432 </tr>
 433 <tr>
 434 <td class="enum_member_name"><p><a name="NICE-CANDIDATE-TRANSPORT-TCP-SO:CAPS"></a>NICE_CANDIDATE_TRANSPORT_TCP_SO</p></td>
 435 <td class="enum_member_description">
 436 <p>TCP Simultaneous-Open transport</p>
 437 </td>
 438 <td class="enum_member_annotations"> </td>
 439 </tr>
 440 </tbody>
 441 </table></div>
 442 </div>
 443 </div>
 444 <hr>
 445 <div class="refsect2">
 446 <a name="TurnServer"></a><h3>struct TurnServer</h3>
 447 <pre class="programlisting">struct TurnServer {
 448   gint ref_count;
 449
 450   NiceAddress server;
 451   gchar *username;
 452   gchar *password;
 453   NiceRelayType type;
 454 };
 455 </pre>
 456 <p>A structure to store the TURN relay settings</p>
 457 <div class="refsect3">
 458 <a name="TurnServer.members"></a><h4>Members</h4>
 459 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 460 <colgroup>
 461 <col width="300px" class="struct_members_name">
 462 <col class="struct_members_description">
 463 <col width="200px" class="struct_members_annotations">
 464 </colgroup>
 465 <tbody>
 466 <tr>
 467 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-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>
 468 <td class="struct_member_description"><p>Reference count for the structure.</p></td>
 469 <td class="struct_member_annotations"> </td>
 470 </tr>
 471 <tr>
 472 <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>
 473 <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>
 474 <td class="struct_member_annotations"> </td>
 475 </tr>
 476 <tr>
 477 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TurnServer.username"></a>username</code></em>;</p></td>
 478 <td class="struct_member_description"><p>The TURN username</p></td>
 479 <td class="struct_member_annotations"> </td>
 480 </tr>
 481 <tr>
 482 <td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="TurnServer.password"></a>password</code></em>;</p></td>
 483 <td class="struct_member_description"><p>The TURN password</p></td>
 484 <td class="struct_member_annotations"> </td>
 485 </tr>
 486 <tr>
 487 <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>
 488 <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>
 489 <td class="struct_member_annotations"> </td>
 490 </tr>
 491 </tbody>
 492 </table></div>
 493 </div>
 494 </div>
 495 <hr>
 496 <div class="refsect2">
 497 <a name="NiceRelayType"></a><h3>enum NiceRelayType</h3>
 498 <p>An enum representing the type of relay to use</p>
 499 <div class="refsect3">
 500 <a name="NiceRelayType.members"></a><h4>Members</h4>
 501 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 502 <colgroup>
 503 <col width="300px" class="enum_members_name">
 504 <col class="enum_members_description">
 505 <col width="200px" class="enum_members_annotations">
 506 </colgroup>
 507 <tbody>
 508 <tr>
 509 <td class="enum_member_name"><p><a name="NICE-RELAY-TYPE-TURN-UDP:CAPS"></a>NICE_RELAY_TYPE_TURN_UDP</p></td>
 510 <td class="enum_member_description">
 511 <p>A TURN relay using UDP</p>
 512 </td>
 513 <td class="enum_member_annotations"> </td>
 514 </tr>
 515 <tr>
 516 <td class="enum_member_name"><p><a name="NICE-RELAY-TYPE-TURN-TCP:CAPS"></a>NICE_RELAY_TYPE_TURN_TCP</p></td>
 517 <td class="enum_member_description">
 518 <p>A TURN relay using TCP</p>
 519 </td>
 520 <td class="enum_member_annotations"> </td>
 521 </tr>
 522 <tr>
 523 <td class="enum_member_name"><p><a name="NICE-RELAY-TYPE-TURN-TLS:CAPS"></a>NICE_RELAY_TYPE_TURN_TLS</p></td>
 524 <td class="enum_member_description">
 525 <p>A TURN relay using TLS over TCP</p>
 526 </td>
 527 <td class="enum_member_annotations"> </td>
 528 </tr>
 529 </tbody>
 530 </table></div>
 531 </div>
 532 </div>
 533 <hr>
 534 <div class="refsect2">
 535 <a name="NICE-CANDIDATE-MAX-FOUNDATION:CAPS"></a><h3>NICE_CANDIDATE_MAX_FOUNDATION</h3>
 536 <pre class="programlisting">#define NICE_CANDIDATE_MAX_FOUNDATION                (32+1)
 537 </pre>
 538 <p>The maximum size a candidate foundation can have.</p>
 539 </div>
 540 </div>
 541 <div class="refsect1">
 542 <a name="NiceCandidate.see-also"></a><h2>See Also</h2>
 543 <p><a class="link" href="libnice-NiceAddress.html#NiceAddress" title="NiceAddress"><span class="type">NiceAddress</span></a></p>
 544 </div>
 545 </div>
 546 <div class="footer">
 547 <hr>Generated by GTK-Doc V1.29</div>
 548 </body>
 549 </html>