debug.h 3.71 KB
Newer Older
1 2 3 4
/*
 * This file is part of the Nice GLib ICE library.
 *
 * (C) 2008 Collabora Ltd.
5
 *  Contact: Youness Alaoui
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
 * (C) 2008 Nokia Corporation. All rights reserved.
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Nice GLib ICE library.
 *
 * The Initial Developers of the Original Code are Collabora Ltd and Nokia
 * Corporation. All Rights Reserved.
 *
 * Contributors:
 *   Youness Alaoui, Collabora Ltd.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
 * case the provisions of LGPL are applicable instead of those above. If you
 * wish to allow use of your version of this file only under the terms of the
 * LGPL and not to allow others to use your version of this file under the
 * MPL, indicate your decision by deleting the provisions above and replace
 * them with the notice and other provisions required by the LGPL. If you do
 * not delete the provisions above, a recipient may use your version of this
 * file under either the MPL or the LGPL.
 */

Olivier Crête's avatar
Olivier Crête committed
37 38
#ifndef __LIBNICE_DEBUG_H__
#define __LIBNICE_DEBUG_H__
39

Youness Alaoui's avatar
Youness Alaoui committed
40 41 42 43

/**
 * SECTION:debug
 * @short_description: Debug messages utility functions
44
 * @stability: Unstable
Youness Alaoui's avatar
Youness Alaoui committed
45
 *
46
 * <para>Libnice can output a lot of information when debug messages are enabled.
47
 * This can significantly help track down problems and/or understand what
48 49 50
 * it's doing.</para>
 *
 * <para>You can enable/disable the debug messages by calling nice_debug_enable()
51
 * or nice_debug_disable() and choosing whether you want only ICE debug messages
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
 * or also stun debug messages.</para>
 *
 * <para>By default, the debug messages are disabled, unless the environment
 * variable NICE_DEBUG is set, in which case, it must contain a comma separated
 * list of flags specifying which debug to enable.</para>
 * <para> The currently available flags are "nice", "stun", "pseudotcp",
 * "pseudotcp-verbose" or "all" to enable all debug messages.</para>
 * <para> If the 'pseudotcp' flag is enabled, then 'pseudotcp-verbose' gets
 * automatically disabled. This is to allow the use of the 'all' flag without
 * having verbose messages from pseudotcp. You can enable verbose debug messages
 * from the pseudotcp layer by specifying 'pseudotcp-verbose' without the
 * 'pseudotcp' flag.</para>
 *
 *
 * <para>This API is unstable and is subject to change at any time...
 * More flags are to come and a better API to enable/disable each flag
 * should be added.</para>
Youness Alaoui's avatar
Youness Alaoui committed
69 70 71
 */


72 73
#include <glib.h>

74 75
G_BEGIN_DECLS

Youness Alaoui's avatar
Youness Alaoui committed
76 77
/**
 * nice_debug_enable:
78
 * @with_stun: Also enable STUN debugging messages
Youness Alaoui's avatar
Youness Alaoui committed
79
 *
80 81 82 83 84 85 86 87 88 89 90
 * Enables libnice debug output to the terminal. Note that the
 * `G_MESSAGES_DEBUG` and `NICE_DEBUG` environment variables must be set to the
 * set of logging domains to print, in order for any output to be printed. Set
 * them to `all` to print all debugging messages, or any of the following
 * domains:
 * - `libnice-stun`
 * - `libnice-tests`
 * - `libnice-socket`
 * - `libnice`
 * - `libnice-pseudotcp`
 * - `libnice-pseudotcp-verbose`
Youness Alaoui's avatar
Youness Alaoui committed
91
 */
92
void nice_debug_enable (gboolean with_stun);
Youness Alaoui's avatar
Youness Alaoui committed
93 94 95 96 97 98 99

/**
 * nice_debug_disable:
 * @with_stun: Also disable stun debugging messages
 *
 * Disables libnice debug output to the terminal
 */
100
void nice_debug_disable (gboolean with_stun);
Youness Alaoui's avatar
Youness Alaoui committed
101

102 103
G_END_DECLS

Olivier Crête's avatar
Olivier Crête committed
104
#endif /* __LIBNICE_DEBUG_H__ */
105