MythTV: hdhomerun_debug.h Source File

00001 /*
00002  * hdhomerun_debug.h
00003  *
00004  * Copyright © 2006 Silicondust USA Inc. <www.silicondust.com>.
00005  *
00006  * This library is free software; you can redistribute it and/or 
00007  * modify it under the terms of the GNU Lesser General Public
00008  * License as published by the Free Software Foundation; either
00009  * version 3 of the License, or (at your option) any later version.
00010  *
00011  * This library is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014  * Lesser General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU Lesser General Public
00017  * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
00018  * 
00019  * As a special exception to the GNU Lesser General Public License,
00020  * you may link, statically or dynamically, an application with a
00021  * publicly distributed version of the Library to produce an
00022  * executable file containing portions of the Library, and
00023  * distribute that executable file under terms of your choice,
00024  * without any of the additional requirements listed in clause 4 of
00025  * the GNU Lesser General Public License.
00026  * 
00027  * By "a publicly distributed version of the Library", we mean
00028  * either the unmodified Library as distributed by Silicondust, or a
00029  * modified version of the Library that is distributed under the
00030  * conditions defined in the GNU Lesser General Public License.
00031  */
00032 
00033 /*
00034  * The debug logging includes optional support for connecting to the
00035  * Silicondust support server. This option should not be used without
00036  * being explicitly enabled by the user. Debug information should be
00037  * limited to information useful to diagnosing a problem.
00038  *  - Silicondust.
00039  */
00040 
00041 #ifdef __cplusplus
00042 extern "C" {
00043 #endif
00044 
00045 struct hdhomerun_debug_t;
00046 
00047 extern LIBTYPE struct hdhomerun_debug_t *hdhomerun_debug_create(void);
00048 extern LIBTYPE void hdhomerun_debug_destroy(struct hdhomerun_debug_t *dbg);
00049 
00050 extern LIBTYPE void hdhomerun_debug_set_prefix(struct hdhomerun_debug_t *dbg, const char *prefix);
00051 extern LIBTYPE void hdhomerun_debug_set_filename(struct hdhomerun_debug_t *dbg, const char *filename);
00052 extern LIBTYPE void hdhomerun_debug_enable(struct hdhomerun_debug_t *dbg);
00053 extern LIBTYPE void hdhomerun_debug_disable(struct hdhomerun_debug_t *dbg);
00054 extern LIBTYPE bool_t hdhomerun_debug_enabled(struct hdhomerun_debug_t *dbg);
00055 
00056 extern LIBTYPE void hdhomerun_debug_flush(struct hdhomerun_debug_t *dbg, uint64_t timeout);
00057 extern LIBTYPE void hdhomerun_debug_close(struct hdhomerun_debug_t *dbg, uint64_t timeout);
00058 
00059 extern LIBTYPE void hdhomerun_debug_printf(struct hdhomerun_debug_t *dbg, const char *fmt, ...);
00060 extern LIBTYPE void hdhomerun_debug_vprintf(struct hdhomerun_debug_t *dbg, const char *fmt, va_list args);
00061 
00062 #ifdef __cplusplus
00063 }
00064 #endif