TpDebugClient

TpDebugClient — proxy objects for Telepathy debug information

Synopsis

#include <telepathy-glib/telepathy-glib.h>

                    TpDebugClient;
                    TpDebugClientClass;
void                tp_debug_client_init_known_interfaces
                                                        (void);
TpDebugClient *     tp_debug_client_new                 (TpDBusDaemon *dbus,
                                                         const gchar *unique_name,
                                                         GError **error);
void                tp_debug_client_set_enabled_async   (TpDebugClient *self,
                                                         gboolean enabled,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
gboolean            tp_debug_client_set_enabled_finish  (TpDebugClient *self,
                                                         GAsyncResult *result,
                                                         GError **error);
gboolean            tp_debug_client_is_enabled          (TpDebugClient *self);

Object Hierarchy

  GObject
   +----TpProxy
         +----TpDebugClient

Properties

  "enabled"                  gboolean              : Read

Signals

  "new-debug-message"                              : Run Last

Description

This module provides access to the auxiliary objects used to implement TpSvcDebug.

Details

TpDebugClient

typedef struct _TpDebugClient TpDebugClient;

A proxy object for the debug interface of a Telepathy component.

Since 0.19.0


TpDebugClientClass

typedef struct _TpDebugClientClass TpDebugClientClass;

The class of a TpDebugClient.

Since 0.19.0


tp_debug_client_init_known_interfaces ()

void                tp_debug_client_init_known_interfaces
                                                        (void);

Ensure that the known interfaces for TpDebugClient have been set up. This is done automatically when necessary, but for correct overriding of library interfaces by local extensions, you should call this function before calling tp_proxy_or_subclass_hook_on_interface_add() with first argument TP_TYPE_DEBUG_CLIENT.

Since 0.19.0


tp_debug_client_new ()

TpDebugClient *     tp_debug_client_new                 (TpDBusDaemon *dbus,
                                                         const gchar *unique_name,
                                                         GError **error);

dbus :

a D-Bus daemon; may not be NULL

unique_name :

the unique name of the process to be debugged; may not be NULL or a well-known name

error :

used to raise an error if unique_name is not valid

Returns :

a new debug client proxy, or NULL on invalid arguments

Since 0.19.0


tp_debug_client_set_enabled_async ()

void                tp_debug_client_set_enabled_async   (TpDebugClient *self,
                                                         gboolean enabled,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Enable or disable publishing of debug messages on the bus by the component owning self's bus name.

self :

a TpDebugClient

enabled :

TRUE if debug messages should be published on the bus, FALSE otherwise

callback :

a callback to call when the request is satisfied

user_data :

data to pass to callback

Since 0.19.0


tp_debug_client_set_enabled_finish ()

gboolean            tp_debug_client_set_enabled_finish  (TpDebugClient *self,
                                                         GAsyncResult *result,
                                                         GError **error);

Finishes tp_debug_client_set_enabled_async().

self :

a TpDebugClient

result :

a GAsyncResult

error :

a GError to fill

Returns :

TRUE, if the operation suceeded, FALSE otherwise

Since 0.19.0


tp_debug_client_is_enabled ()

gboolean            tp_debug_client_is_enabled          (TpDebugClient *self);

Return the "enabled" property

self :

a TpDebugClient

Returns :

the value of "enabled" property

Since 0.19.0

Property Details

The "enabled" property

  "enabled"                  gboolean              : Read

TRUE if debug messages are published on the bus.

This property is meaningless until the TP_DEBUG_CLIENT_FEATURE_CORE feature has been prepared.

Default value: FALSE

Since 0.19.0

Signal Details

The "new-debug-message" signal

void                user_function                      (TpDebugClient  *self,
                                                        TpDebugMessage *message,
                                                        gpointer        user_data)      : Run Last

Emitted when a TpDebugMessage is generated if the TpDebugMessage:enabled property is set to TRUE.

self :

a TpDebugClient

message :

a TpDebugMessage

user_data :

user data set when the signal handler was connected.

Since 0.19.0

See Also

TpProxy