Debian Codegraph @

src/libqmi-glib/qmi-utils.h

raw
1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3 /*
4 * libqmi-glib -- GLib/GIO based library to control QMI devices
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 * Boston, MA 02110-1301 USA.
20 *
21 * Copyright (C) 2012-2015 Dan Williams <[email protected]>
22 * Copyright (C) 2012-2017 Aleksander Morgado <[email protected]>
23 * Copyright (C) 1999,2000 Erik Walthinsen <[email protected]>
24 * Copyright (C) 2000 Wim Taymans <[email protected]>
25 * Copyright (C) 2002 Thomas Vander Stichele <[email protected]>
26 * Copyright (c) 2022 Qualcomm Innovation Center, Inc.
27 */
28
29 #ifndef _LIBQMI_GLIB_QMI_UTILS_H_
30 #define _LIBQMI_GLIB_QMI_UTILS_H_
31
32 #if !defined (__LIBQMI_GLIB_H_INSIDE__) && !defined (LIBQMI_GLIB_COMPILATION)
33 #error "Only <libqmi-glib.h> can be included directly."
34 #endif
35
36 #include <glib.h>
37
38 G_BEGIN_DECLS
39
40 /**
41 * SECTION: qmi-utils
42 * @title: Common utilities
43 * @short_description: Common utilities in the library.
44 *
45 * This section exposes a set of common utilities that may be used to work
46 * with the QMI library.
47 */
48
49 /* Enabling/Disabling traces */
50
51 /**
52 * qmi_utils_get_traces_enabled:
53 *
54 * Checks whether QMI message traces are currently enabled.
55 *
56 * Returns: %TRUE if traces are enabled, %FALSE otherwise.
57 *
58 * Since: 1.0
59 */
60 gboolean qmi_utils_get_traces_enabled (void);
61
62 /**
63 * qmi_utils_set_traces_enabled:
64 * @enabled: %TRUE to enable traces, %FALSE to disable them.
65 *
66 * Sets whether QMI message traces are enabled or disabled.
67 *
68 * Since: 1.0
69 */
70 void qmi_utils_set_traces_enabled (gboolean enabled);
71
72 /**
73 * qmi_utils_set_show_personal_info:
74 * @show_personal_info: %TRUE to show personal info in traces, %FALSE otherwise.
75 *
76 * Sets whether personal info is printed when traces are enabled.
77 *
78 * Since: 1.32
79 */
80 void qmi_utils_set_show_personal_info (gboolean show_personal_info);
81
82 /**
83 * qmi_utils_get_show_personal_info:
84 *
85 * Checks whether personal info should be hidden when traces are enabled.
86 *
87 * Returns: %TRUE to show personal info in trace, %FALSE otherwise.
88 *
89 * Since: 1.32
90 */
91 gboolean qmi_utils_get_show_personal_info (void);
92
93 G_END_DECLS
94
95 #endif /* _LIBQMI_GLIB_QMI_UTILS_H_ */