debug.h 2.93 KB
Newer Older
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
/*
 * This file is part of the Nice GLib ICE library.
 *
 * (C) 2008 Collabora Ltd.
 * (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.
 */

#ifndef _DEBUG_H
#define _DEBUG_H

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

/**
 * SECTION:debug
 * @short_description: Debug messages utility functions
43 44
 * @stability: More flags are to come and a better API to
 * enable/disable each flag should be added. Unstable
Youness Alaoui's avatar
Youness Alaoui committed
45
 *
46 47 48 49 50 51 52 53 54 55
 * Libnice can output a lot of information when debug messages are enabled.
 * This can significantly help track down problems and/or understand what
 * it's doing.
 * You can enable/disable the debug messages by calling nice_debug_enable()
 * or nice_debug_disable() and choosing whether you want only ICE debug messages
 * or also stun debug messages.
 * 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. The flags can be "nice", "stun",
 * or "all" to enable all debug messages.
Youness Alaoui's avatar
Youness Alaoui committed
56 57 58
 */


59 60
#include <glib.h>

Youness Alaoui's avatar
Youness Alaoui committed
61 62 63 64 65 66
/**
 * nice_debug_init:
 *
 * Initialize the debugging system. Uses the NICE_DEBUG environment variable
 * to set the appropriate debugging flags
 */
67
void nice_debug_init (void);
Youness Alaoui's avatar
Youness Alaoui committed
68 69 70 71 72 73 74

/**
 * nice_debug_enable:
 * @with_stun: Also enable stun debugging messages
 *
 * Enables libnice debug output to the terminal
 */
75
void nice_debug_enable (gboolean with_stun);
Youness Alaoui's avatar
Youness Alaoui committed
76 77 78 79 80 81 82

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

85 86 87 88
void nice_debug (const char *fmt, ...);

#endif /* _DEBUG_H */