From 0cbb9fe558f4652c5a0f70a2864a061665ba605e Mon Sep 17 00:00:00 2001 From: Jonny Lamb Date: Sun, 19 Apr 2009 19:38:42 +0100 Subject: Add Debug interface. Signed-off-by: Jonny Lamb --- extensions/Debug.xml | 112 +++++++++++++++++++++++++++++++++++++++++++++++++ extensions/Makefile.am | 3 +- extensions/misc.xml | 1 + 3 files changed, 115 insertions(+), 1 deletion(-) create mode 100644 extensions/Debug.xml (limited to 'extensions') diff --git a/extensions/Debug.xml b/extensions/Debug.xml new file mode 100644 index 000000000..96c4cfb7d --- /dev/null +++ b/extensions/Debug.xml @@ -0,0 +1,112 @@ + + + Copyright (C) 2009 Collabora Ltd. + +

This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version.

+ +

This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details.

+ +

You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

+ + + + +

An interface for providing debug messages. + + This interface is primarily provided by one object per + service, at the path /org/freedesktop/Telepathy/debug. +

+ + + + +

TRUE if the NewDebugMessage signal should be emitted when a new + debug message is generated.

+ + + + + +

Retrieve buffered debug messages.

+ + + + + A list of timestamped debug messages. + + + + + + + Emitted when a debug messages is generated if the Enabled property is + set. + + + + + Message timestamp + + + + + Message domain + + + + + Message level + + + + + Message + + + + + + + + error + + + + + criticla + + + + + warning + + + + + message + + + + + info + + + + + debug + + + + + + + diff --git a/extensions/Makefile.am b/extensions/Makefile.am index e5b1ea113..f179ebc19 100644 --- a/extensions/Makefile.am +++ b/extensions/Makefile.am @@ -16,7 +16,8 @@ EXTRA_DIST = \ Tube_Handler.xml \ Channel_Interface_Tube.xml \ Channel_Type_DBus_Tube.xml \ - Channel_Type_Stream_Tube.xml + Channel_Type_Stream_Tube.xml \ + Debug.xml noinst_LTLIBRARIES = libemp-extensions.la diff --git a/extensions/misc.xml b/extensions/misc.xml index 5c89ff0d8..38e802e97 100644 --- a/extensions/misc.xml +++ b/extensions/misc.xml @@ -9,5 +9,6 @@ + -- cgit v1.2.3 From de1ff4426cd4b50bbea43e882bddd894936b2313 Mon Sep 17 00:00:00 2001 From: Jonny Lamb Date: Wed, 3 Jun 2009 13:10:05 +0100 Subject: Updated Debug spec. Signed-off-by: Jonny Lamb --- extensions/Debug.xml | 140 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 97 insertions(+), 43 deletions(-) (limited to 'extensions') diff --git a/extensions/Debug.xml b/extensions/Debug.xml index 96c4cfb7d..a21d9db60 100644 --- a/extensions/Debug.xml +++ b/extensions/Debug.xml @@ -17,96 +17,150 @@ Lesser General Public License for more details.

License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

- + + -

An interface for providing debug messages. +

An interface for providing debug messages.

- This interface is primarily provided by one object per - service, at the path /org/freedesktop/Telepathy/debug. -

+

This interface is primarily provided by one object per + service, at the path /org/freedesktop/Telepathy/debug.

 - - -

TRUE if the NewDebugMessage signal should be emitted when a new - debug message is generated.

+ + + TRUE if the NewDebugMessage signal + should be emitted when a new debug message is generated. - - -

Retrieve buffered debug messages.

+ + + Retrieve buffered debug messages. An implementation could have a + limit on how many message it keeps and so the array returned from + this method should not be assumed to be all of the messages in + the lifetime of the service. - - - A list of timestamped debug messages. + + + A list of debug messages. - Emitted when a debug messages is generated if the Enabled property is - set. + Emitted when a debug messages is generated if the + Enabled property is set to TRUE. - Message timestamp + Timestamp of the debug message. - - Message domain - + + Domain of the debug message, as described in the Debug_Message struct. + - - Message level - + + Level of the debug message. + - Message + The text of the debug message. - - error - + + Log level for errors. Error messages are always fatal, resulting + in the service terminating after something completely + unexpected occurred. + - - criticla - + + Log level for critical messages. Critical messages are messages + that the service might predict and it is up to the service itself + to decide whether to terminate following a critical message. + - - warning - + + Log level for warnings. + - - message - + + Log level for messages. + - - info - + + Log level for information messages. + - - debug - + + Log level for debug messages. + + + + A struct representing a debug message, as returned by + GetMessages. + + + + + Timestamp of the debug message. This is a double to allow + more accuracy in the time the message was logged. + + + + + +

Domain of the debug message. This is used to identify + the source of debug messages. For example, debug messages + from a connection manager could have this Domain struct + member be the name of the connection manager, and logs + from any helper library could have the name of the helper + library.

+ +

The domain could also contain a category as to where + the log message originated separated by a forward-slash. + For example, if a debug message was output in a connection + manager called "dummy", in the file-transfer code, this + Domain struct member might be dummy/file-transfer.

+ + + + + + Level of the debug message. This states the severity of the + debug message. + + + + + + The text of the debug message. + + + + -- cgit v1.2.3