3 xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4 <tp:copyright>Copyright (C) 2009 Collabora Ltd.</tp:copyright>
5 <tp:license xmlns="http://www.w3.org/1999/xhtml">
6 <p>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.1 of the License, or (at your option) any later version.</p>
11 <p>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.</p>
16 <p>You should have received a copy of the GNU Lesser General Public
17 License along with this library; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
20 <interface name="org.freedesktop.Telepathy.Debug.DRAFT"
21 tp:causes-havoc="experimental">
22 <tp:added version="0.17.24"/>
24 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
25 <p>An interface for providing debug messages.</p>
27 <p>This interface is primarily provided by one object per
28 service, at the path <tt>/org/freedesktop/Telepathy/debug</tt>.</p>
31 <property name="Enabled" type="b" access="readwrite"
32 tp:name-for-bindings="Enabled">
34 TRUE if the <tp:member-ref>NewDebugMessage</tp:member-ref> signal
35 should be emitted when a new debug message is generated.
39 <method name="GetMessages" tp:name-for-bindings="Get_Messages">
41 Retrieve buffered debug messages. An implementation could have a
42 limit on how many message it keeps and so the array returned from
43 this method should not be assumed to be all of the messages in
44 the lifetime of the service.
47 <arg direction="out" name="Messages" type="a(dsus)"
48 tp:type="Debug_Message[]">
50 A list of debug messages.
55 <signal name="NewDebugMessage" tp:name-for-bindings="New_Debug_Message">
57 Emitted when a debug messages is generated if the
58 <tp:member-ref>Enabled</tp:member-ref> property is set to TRUE.
61 <arg name="time" type="d">
63 Timestamp of the debug message.
66 <arg name="domain" type="s">
68 Domain of the debug message, as described in the Debug_Message struct.
71 <arg name="level" type="u" tp:type="Debug_Level">
73 Level of the debug message.
76 <arg name="message" type="s">
78 The text of the debug message.
83 <tp:enum name="Debug_Level" type="u">
84 <tp:enumvalue suffix="Error" value="0">
86 Log level for errors. Error messages are always fatal, resulting
87 in the service terminating after something completely
91 <tp:enumvalue suffix="Critical" value="1">
93 Log level for critical messages. Critical messages are messages
94 that the service might predict and it is up to the service itself
95 to decide whether to terminate following a critical message.
98 <tp:enumvalue suffix="Warning" value="2">
100 Log level for warnings.
103 <tp:enumvalue suffix="Message" value="3">
105 Log level for messages.
108 <tp:enumvalue suffix="Info" value="4">
110 Log level for information messages.
113 <tp:enumvalue suffix="Debug" value="5">
115 Log level for debug messages.
120 <tp:struct name="Debug_Message" array-name="Debug_Message_List">
122 A struct representing a debug message, as returned by
123 <tp:member-ref>GetMessages</tp:member-ref>.
126 <tp:member type="d" name="Timestamp">
128 Timestamp of the debug message. This is a double to allow
129 more accuracy in the time the message was logged.
133 <tp:member type="s" name="Domain">
134 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
135 <p>Domain of the debug message. This is used to identify
136 the source of debug messages. For example, debug messages
137 from a connection manager could have this Domain struct
138 member be the name of the connection manager, and logs
139 from any helper library could have the name of the helper
142 <p>The domain could also contain a category as to where
143 the log message originated separated by a forward-slash.
144 For example, if a debug message was output in a connection
145 manager called "dummy", in the file-transfer code, this
146 Domain struct member might be <tt>dummy/file-transfer</tt>.</p>
150 <tp:member type="u" tp:type="Debug_Level" name="Level">
152 Level of the debug message. This states the severity of the
157 <tp:member type="s" name="Message">
159 The text of the debug message.
166 <!-- vim:set sw=2 sts=2 et ft=xml: -->