docs/reference/libnice/html/libnice-Debug-messages.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>Debug messages: 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="ch02.html" title="Libnice helper functions">
   9 <link rel="prev" href="ch02.html" title="Libnice helper functions">
  10 <link rel="next" href="libnice-Network-interfaces-discovery.html" title="Network interfaces discovery">
  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="#libnice-Debug-messages.description" class="shortcut">Description</a></span>
  19 </td>
  20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  21 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="libnice-Network-interfaces-discovery.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  24 </tr></table>
  25 <div class="refentry">
  26 <a name="libnice-Debug-messages"></a><div class="titlepage"></div>
  27 <div class="refnamediv"><table width="100%"><tr>
  28 <td valign="top">
  29 <h2><span class="refentrytitle"><a name="libnice-Debug-messages.top_of_page"></a>Debug messages</span></h2>
  30 <p>Debug messages — Debug messages utility functions</p>
  31 </td>
  32 <td class="gallery_image" valign="top" align="right"></td>
  33 </tr></table></div>
  34 <div class="refsect1">
  35 <a name="libnice-Debug-messages.stability-level"></a><h2>Stability Level</h2>
  36 <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
  37 give outside developers early access to new or rapidly changing technology, or
  38 to provide an interim solution to a problem where a more general solution is
  39 anticipated. No claims are made about either source or binary compatibility from
  40 one minor release to the next.
  41
  42 The Unstable interface level is a warning that these interfaces are  subject to
  43 change without warning and should not be used in unbundled products.
  44
  45 Given such caveats, customer impact need not be a factor when considering
  46 incompatible changes to an Unstable interface in a major or minor release.
  47 Nonetheless, when such changes are introduced, the changes should still be
  48 mentioned in the release notes for the affected release.
  49 "><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
  50 </div>
  51 <div class="refsect1">
  52 <a name="libnice-Debug-messages.functions"></a><h2>Functions</h2>
  53 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  54 <colgroup>
  55 <col width="150px" class="functions_return">
  56 <col class="functions_name">
  57 </colgroup>
  58 <tbody>
  59 <tr>
  60 <td class="function_type">
  61 <span class="returnvalue">void</span>
  62 </td>
  63 <td class="function_name">
  64 <a class="link" href="libnice-Debug-messages.html#nice-debug-enable" title="nice_debug_enable ()">nice_debug_enable</a> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <span class="returnvalue">void</span>
  70 </td>
  71 <td class="function_name">
  72 <a class="link" href="libnice-Debug-messages.html#nice-debug-disable" title="nice_debug_disable ()">nice_debug_disable</a> <span class="c_punctuation">()</span>
  73 </td>
  74 </tr>
  75 </tbody>
  76 </table></div>
  77 </div>
  78 <div class="refsect1">
  79 <a name="libnice-Debug-messages.description"></a><h2>Description</h2>
  80 <p>Libnice can output a lot of information when debug messages are enabled.
  81 This can significantly help track down problems and/or understand what
  82 it's doing.</p>
  83 <p>You can enable/disable the debug messages by calling <a class="link" href="libnice-Debug-messages.html#nice-debug-enable" title="nice_debug_enable ()"><code class="function">nice_debug_enable()</code></a>
  84 or <a class="link" href="libnice-Debug-messages.html#nice-debug-disable" title="nice_debug_disable ()"><code class="function">nice_debug_disable()</code></a> and choosing whether you want only ICE debug messages
  85 or also stun debug messages.</p>
  86 <p>By default, the debug messages are disabled, unless the environment
  87 variable NICE_DEBUG is set, in which case, it must contain a comma separated
  88 list of flags specifying which debug to enable.</p>
  89 <p> The currently available flags are "nice", "stun", "pseudotcp",
  90 "pseudotcp-verbose" or "all" to enable all debug messages.</p>
  91 <p> If the 'pseudotcp' flag is enabled, then 'pseudotcp-verbose' gets
  92 automatically disabled. This is to allow the use of the 'all' flag without
  93 having verbose messages from pseudotcp. You can enable verbose debug messages
  94 from the pseudotcp layer by specifying 'pseudotcp-verbose' without the
  95 'pseudotcp' flag.</p>
  96 <p>This API is unstable and is subject to change at any time...
  97 More flags are to come and a better API to enable/disable each flag
  98 should be added.</p>
  99 </div>
 100 <div class="refsect1">
 101 <a name="libnice-Debug-messages.functions_details"></a><h2>Functions</h2>
 102 <div class="refsect2">
 103 <a name="nice-debug-enable"></a><h3>nice_debug_enable ()</h3>
 104 <pre class="programlisting"><span class="returnvalue">void</span>
 105 nice_debug_enable (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> with_stun</code></em>);</pre>
 106 <p>Enables libnice debug output to the terminal. Note that the
 107 <code class="literal">G_MESSAGES_DEBUG</code> and <code class="literal">NICE_DEBUG</code> environment variables must be set to the
 108 set of logging domains to print, in order for any output to be printed. Set
 109 them to <code class="literal">all</code> to print all debugging messages, or any of the following
 110 domains:</p>
 111 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 112 <li class="listitem"><p><code class="literal">libnice-stun</code></p></li>
 113 <li class="listitem"><p><code class="literal">libnice-tests</code></p></li>
 114 <li class="listitem"><p><code class="literal">libnice-socket</code></p></li>
 115 <li class="listitem"><p><code class="literal">libnice</code></p></li>
 116 <li class="listitem"><p><code class="literal">libnice-pseudotcp</code></p></li>
 117 <li class="listitem"><p><code class="literal">libnice-pseudotcp-verbose</code></p></li>
 118 </ul></div>
 119 <div class="refsect3">
 120 <a name="nice-debug-enable.parameters"></a><h4>Parameters</h4>
 121 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 122 <colgroup>
 123 <col width="150px" class="parameters_name">
 124 <col class="parameters_description">
 125 <col width="200px" class="parameters_annotations">
 126 </colgroup>
 127 <tbody><tr>
 128 <td class="parameter_name"><p>with_stun</p></td>
 129 <td class="parameter_description"><p>Also enable STUN debugging messages</p></td>
 130 <td class="parameter_annotations"> </td>
 131 </tr></tbody>
 132 </table></div>
 133 </div>
 134 </div>
 135 <hr>
 136 <div class="refsect2">
 137 <a name="nice-debug-disable"></a><h3>nice_debug_disable ()</h3>
 138 <pre class="programlisting"><span class="returnvalue">void</span>
 139 nice_debug_disable (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> with_stun</code></em>);</pre>
 140 <p>Disables libnice debug output to the terminal</p>
 141 <div class="refsect3">
 142 <a name="nice-debug-disable.parameters"></a><h4>Parameters</h4>
 143 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 144 <colgroup>
 145 <col width="150px" class="parameters_name">
 146 <col class="parameters_description">
 147 <col width="200px" class="parameters_annotations">
 148 </colgroup>
 149 <tbody><tr>
 150 <td class="parameter_name"><p>with_stun</p></td>
 151 <td class="parameter_description"><p>Also disable stun debugging messages</p></td>
 152 <td class="parameter_annotations"> </td>
 153 </tr></tbody>
 154 </table></div>
 155 </div>
 156 </div>
 157 </div>
 158 <div class="refsect1">
 159 <a name="libnice-Debug-messages.other_details"></a><h2>Types and Values</h2>
 160 </div>
 161 </div>
 162 <div class="footer">
 163 <hr>Generated by GTK-Doc V1.29</div>
 164 </body>
 165 </html>