extensions/Debug.xml

   1 <?xml version="1.0" ?>
   2 <node name="/Debug"
   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>
  10
  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>
  15
  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>
  19   </tp:license>
  20   <interface name="org.freedesktop.Telepathy.Debug">
  21     <tp:added version="0.17.27">(as stable API)</tp:added>
  22
  23     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  24       <p>An interface for providing debug messages.</p>
  25
  26       <p>This interface is primarily provided by one object per
  27       service, at the path <tt>/org/freedesktop/Telepathy/debug</tt>.</p>
  28     </tp:docstring>
  29
  30     <property name="Enabled" type="b" access="readwrite"
  31       tp:name-for-bindings="Enabled">
  32       <tp:docstring>
  33         TRUE if the <tp:member-ref>NewDebugMessage</tp:member-ref> signal
  34         should be emitted when a new debug message is generated.
  35       </tp:docstring>
  36     </property>
  37
  38     <method name="GetMessages" tp:name-for-bindings="Get_Messages">
  39       <tp:docstring>
  40         Retrieve buffered debug messages. An implementation could have a
  41         limit on how many message it keeps and so the array returned from
  42         this method should not be assumed to be all of the messages in
  43         the lifetime of the service.
  44       </tp:docstring>
  45
  46       <arg direction="out" name="Messages" type="a(dsus)"
  47         tp:type="Debug_Message[]">
  48         <tp:docstring>
  49           A list of debug messages.
  50         </tp:docstring>
  51       </arg>
  52     </method>
  53
  54     <signal name="NewDebugMessage" tp:name-for-bindings="New_Debug_Message">
  55       <tp:docstring>
  56         Emitted when a debug messages is generated if the
  57         <tp:member-ref>Enabled</tp:member-ref> property is set to TRUE.
  58       </tp:docstring>
  59
  60       <arg name="time" type="d">
  61         <tp:docstring>
  62           Timestamp of the debug message.
  63         </tp:docstring>
  64       </arg>
  65       <arg name="domain" type="s">
  66         <tp:docstring>
  67           Domain of the debug message, as described in the Debug_Message struct.
  68         </tp:docstring>
  69       </arg>
  70       <arg name="level" type="u" tp:type="Debug_Level">
  71         <tp:docstring>
  72           Level of the debug message.
  73         </tp:docstring>
  74       </arg>
  75       <arg name="message" type="s">
  76         <tp:docstring>
  77           The text of the debug message.
  78         </tp:docstring>
  79       </arg>
  80     </signal>
  81
  82     <tp:enum name="Debug_Level" type="u">
  83       <tp:enumvalue suffix="Error" value="0">
  84         <tp:docstring>
  85           Log level for errors. Error messages are always fatal, resulting
  86           in the service terminating after something completely
  87           unexpected occurred.
  88         </tp:docstring>
  89       </tp:enumvalue>
  90       <tp:enumvalue suffix="Critical" value="1">
  91         <tp:docstring>
  92           Log level for critical messages. Critical messages are messages
  93           that the service might predict and it is up to the service itself
  94           to decide whether to terminate following a critical message.
  95         </tp:docstring>
  96       </tp:enumvalue>
  97       <tp:enumvalue suffix="Warning" value="2">
  98         <tp:docstring>
  99           Log level for warnings.
 100         </tp:docstring>
 101       </tp:enumvalue>
 102       <tp:enumvalue suffix="Message" value="3">
 103         <tp:docstring>
 104           Log level for messages.
 105         </tp:docstring>
 106       </tp:enumvalue>
 107       <tp:enumvalue suffix="Info" value="4">
 108         <tp:docstring>
 109           Log level for information messages.
 110         </tp:docstring>
 111       </tp:enumvalue>
 112       <tp:enumvalue suffix="Debug" value="5">
 113         <tp:docstring>
 114           Log level for debug messages.
 115         </tp:docstring>
 116       </tp:enumvalue>
 117     </tp:enum>
 118
 119     <tp:struct name="Debug_Message" array-name="Debug_Message_List">
 120       <tp:docstring>
 121         A struct representing a debug message, as returned by
 122         <tp:member-ref>GetMessages</tp:member-ref>.
 123       </tp:docstring>
 124
 125       <tp:member type="d" name="Timestamp">
 126         <tp:docstring>
 127           Timestamp of the debug message. This is a double to allow
 128           more accuracy in the time the message was logged.
 129         </tp:docstring>
 130       </tp:member>
 131
 132       <tp:member type="s" name="Domain">
 133         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 134           <p>Domain of the debug message. This is used to identify
 135           the source of debug messages. For example, debug messages
 136           from a connection manager could have this Domain struct
 137           member be the name of the connection manager, and logs
 138           from any helper library could have the name of the helper
 139           library.</p>
 140
 141           <p>The domain could also contain a category as to where
 142           the log message originated separated by a forward-slash.
 143           For example, if a debug message was output in a connection
 144           manager called "dummy", in the file-transfer code, this
 145           Domain struct member might be <tt>dummy/file-transfer</tt>.</p>
 146         </tp:docstring>
 147       </tp:member>
 148
 149       <tp:member type="u" tp:type="Debug_Level" name="Level">
 150         <tp:docstring>
 151           Level of the debug message. This states the severity of the
 152           debug message.
 153         </tp:docstring>
 154       </tp:member>
 155
 156       <tp:member type="s" name="Message">
 157         <tp:docstring>
 158           The text of the debug message.
 159         </tp:docstring>
 160       </tp:member>
 161     </tp:struct>
 162
 163   </interface>
 164 </node>
 165 <!-- vim:set sw=2 sts=2 et ft=xml: -->