← Back to branch summary

~ubuntu-branches/ubuntu/maverick/telepathy-glib/maverick

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-svc-debug.html

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2009-09-03 20:23:03 UTC
  • mfrom: (1.4.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20090903202303-dhci6f1ri29fyo5c
Tags: 0.7.36-1
New upstream version (API, ABI added)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/telepathy-glib-svc-debug.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>Service-side Debug base interface</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="telepathy-glib Reference Manual">
 
8
<link rel="up" href="ch-service-dbus.html" title="Service-side D-Bus interfaces">
 
9
<link rel="prev" href="telepathy-glib-svc-channel-roomlist.html" title="Room List channels">
 
10
<link rel="next" href="telepathy-glib-svc-connection.html" title="Service-side Connection interfaces">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="ch-dbus.html" title="General D-Bus support">
 
14
<link rel="chapter" href="ch-protocol.html" title="The Telepathy protocol">
 
15
<link rel="chapter" href="ch-client.html" title="Client-side proxies">
 
16
<link rel="chapter" href="ch-service-dbus.html" title="Service-side D-Bus interfaces">
 
17
<link rel="chapter" href="ch-service-base.html" title="Service-side implementation">
 
18
<link rel="chapter" href="ch-service-handles.html" title="Service-side handle repositories">
 
19
<link rel="chapter" href="ch-utilities.html" title="Utilities">
 
20
</head>
 
21
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
22
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
23
<tr valign="middle">
 
24
<td><a accesskey="p" href="telepathy-glib-svc-channel-roomlist.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
25
<td><a accesskey="u" href="ch-service-dbus.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
26
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
27
<th width="100%" align="center">telepathy-glib Reference Manual</th>
 
28
<td><a accesskey="n" href="telepathy-glib-svc-connection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
29
</tr>
 
30
<tr><td colspan="5" class="shortcuts">
 
31
<a href="#telepathy-glib-svc-debug.synopsis" class="shortcut">Top</a>
 
32
                 | 
 
33
                <a href="#telepathy-glib-svc-debug.description" class="shortcut">Description</a>
 
34
                 | 
 
35
                <a href="#telepathy-glib-svc-debug.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
36
                 | 
 
37
                <a href="#telepathy-glib-svc-debug.implementations" class="shortcut">Known Implementations</a>
 
38
                 | 
 
39
                <a href="#telepathy-glib-svc-debug.signals" class="shortcut">Signals</a>
 
40
</td></tr>
 
41
</table>
 
42
<div class="refentry" title="Service-side Debug base interface">
 
43
<a name="telepathy-glib-svc-debug"></a><div class="titlepage"></div>
 
44
<div class="refnamediv"><table width="100%"><tr>
 
45
<td valign="top">
 
46
<h2><span class="refentrytitle"><a name="telepathy-glib-svc-debug.top_of_page"></a>Service-side Debug base interface</span></h2>
 
47
<p>Service-side Debug base interface — GInterface for Telepathy Debug objects</p>
 
48
</td>
 
49
<td valign="top" align="right"></td>
 
50
</tr></table></div>
 
51
<div class="refsynopsisdiv" title="Synopsis">
 
52
<a name="telepathy-glib-svc-debug.synopsis"></a><h2>Synopsis</h2>
 
53
<a name="TpSvcDebug"></a><pre class="synopsis">
 
54
 
 
55
#include &lt;telepathy-glib/svc-debug.h&gt;
 
56
 
 
57
                    <a class="link" href="telepathy-glib-svc-debug.html#TpSvcDebug-struct" title="TpSvcDebug">TpSvcDebug</a>;
 
58
                    <a class="link" href="telepathy-glib-svc-debug.html#TpSvcDebugClass" title="TpSvcDebugClass">TpSvcDebugClass</a>;
 
59
void                (<a class="link" href="telepathy-glib-svc-debug.html#tp-svc-debug-get-messages-impl" title="tp_svc_debug_get_messages_impl ()">*tp_svc_debug_get_messages_impl</a>)   (<a class="link" href="telepathy-glib-svc-debug.html#TpSvcDebug">TpSvcDebug</a> *self,
 
60
                                                         <a
 
61
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGMethod.html#DBusGMethodInvocation"
 
62
>DBusGMethodInvocation</a> *context);
 
63
void                <a class="link" href="telepathy-glib-svc-debug.html#tp-svc-debug-implement-get-messages" title="tp_svc_debug_implement_get_messages ()">tp_svc_debug_implement_get_messages</a> (<a class="link" href="telepathy-glib-svc-debug.html#TpSvcDebugClass" title="TpSvcDebugClass">TpSvcDebugClass</a> *klass,
 
64
                                                         <a class="link" href="telepathy-glib-svc-debug.html#tp-svc-debug-get-messages-impl" title="tp_svc_debug_get_messages_impl ()">tp_svc_debug_get_messages_impl</a> impl);
 
65
void                <a class="link" href="telepathy-glib-svc-debug.html#tp-svc-debug-return-from-get-messages" title="tp_svc_debug_return_from_get_messages ()">tp_svc_debug_return_from_get_messages</a>
 
66
                                                        (<a
 
67
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGMethod.html#DBusGMethodInvocation"
 
68
>DBusGMethodInvocation</a> *context,
 
69
                                                         const <a
 
70
href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"
 
71
>GPtrArray</a> *out_Messages);
 
72
void                <a class="link" href="telepathy-glib-svc-debug.html#tp-svc-debug-emit-new-debug-message" title="tp_svc_debug_emit_new_debug_message ()">tp_svc_debug_emit_new_debug_message</a> (<a
 
73
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
 
74
>gpointer</a> instance,
 
75
                                                         <a
 
76
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
 
77
>gdouble</a> arg_time,
 
78
                                                         const <a
 
79
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
80
>gchar</a> *arg_domain,
 
81
                                                         <a
 
82
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
 
83
>guint</a> arg_level,
 
84
                                                         const <a
 
85
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
86
>gchar</a> *arg_message);
 
87
</pre>
 
88
</div>
 
89
<div class="refsect1" title="Object Hierarchy">
 
90
<a name="telepathy-glib-svc-debug.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
91
<pre class="synopsis">
 
92
  GInterface
 
93
   +----TpSvcDebug
 
94
</pre>
 
95
</div>
 
96
<div class="refsect1" title="Known Implementations">
 
97
<a name="telepathy-glib-svc-debug.implementations"></a><h2>Known Implementations</h2>
 
98
<p>
 
99
TpSvcDebug is implemented by
 
100
 <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender">TpDebugSender</a>.</p>
 
101
</div>
 
102
<div class="refsect1" title="Signals">
 
103
<a name="telepathy-glib-svc-debug.signals"></a><h2>Signals</h2>
 
104
<pre class="synopsis">
 
105
  "<a class="link" href="telepathy-glib-svc-debug.html#TpSvcDebug-new-debug-message" title='The "new-debug-message" signal'>new-debug-message</a>"                              : Run Last / Has Details
 
106
</pre>
 
107
</div>
 
108
<div class="refsect1" title="Description">
 
109
<a name="telepathy-glib-svc-debug.description"></a><h2>Description</h2>
 
110
<p>
 
111
This interface (auto-generated from the Telepathy spec) makes it easier
 
112
to export objects implementing the Telepathy Debug interface.
 
113
</p>
 
114
<p>
 
115
<a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> provides a reference implementation of the Debug object.</p>
 
116
<p>
 
117
</p>
 
118
</div>
 
119
<div class="refsect1" title="Details">
 
120
<a name="telepathy-glib-svc-debug.details"></a><h2>Details</h2>
 
121
<div class="refsect2" title="TpSvcDebug">
 
122
<a name="TpSvcDebug-struct"></a><h3>TpSvcDebug</h3>
 
123
<pre class="programlisting">typedef struct _TpSvcDebug TpSvcDebug;</pre>
 
124
<p>
 
125
Dummy typedef representing any implementation of this interface.</p>
 
126
<p>
 
127
</p>
 
128
</div>
 
129
<hr>
 
130
<div class="refsect2" title="TpSvcDebugClass">
 
131
<a name="TpSvcDebugClass"></a><h3>TpSvcDebugClass</h3>
 
132
<pre class="programlisting">typedef struct _TpSvcDebugClass TpSvcDebugClass;</pre>
 
133
<p>
 
134
The class of TpSvcDebug.
 
135
</p>
 
136
<p>
 
137
In a full implementation of this interface (i.e. all
 
138
methods implemented), the interface initialization
 
139
function used in <a
 
140
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-IMPLEMENT-INTERFACE--CAPS"
 
141
><code class="function">G_IMPLEMENT_INTERFACE()</code></a> would
 
142
typically look like this:
 
143
</p>
 
144
<p>
 
145
</p>
 
146
<pre class="programlisting">
 
147
static void
 
148
implement_debug (gpointer klass,
 
149
    gpointer unused G_GNUC_UNUSED)
 
150
{
 
151
#define IMPLEMENT(x) tp_svc_debug_implement_##x (\
 
152
  klass, my_object_##x)
 
153
  IMPLEMENT (get_messages);
 
154
#undef IMPLEMENT
 
155
}
 
156
</pre>
 
157
<p>
 
158
</p>
 
159
</div>
 
160
<hr>
 
161
<div class="refsect2" title="tp_svc_debug_get_messages_impl ()">
 
162
<a name="tp-svc-debug-get-messages-impl"></a><h3>tp_svc_debug_get_messages_impl ()</h3>
 
163
<pre class="programlisting">void                (*tp_svc_debug_get_messages_impl)   (<a class="link" href="telepathy-glib-svc-debug.html#TpSvcDebug">TpSvcDebug</a> *self,
 
164
                                                         <a
 
165
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGMethod.html#DBusGMethodInvocation"
 
166
>DBusGMethodInvocation</a> *context);</pre>
 
167
<p>
 
168
The signature of an implementation of the D-Bus method
 
169
GetMessages on interface org.freedesktop.Telepathy.Debug.</p>
 
170
<p>
 
171
</p>
 
172
<div class="variablelist"><table border="0">
 
173
<col align="left" valign="top">
 
174
<tbody>
 
175
<tr>
 
176
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
177
<td> The object implementing this interface
 
178
</td>
 
179
</tr>
 
180
<tr>
 
181
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
 
182
<td> Used to return values or throw an error
 
183
</td>
 
184
</tr>
 
185
</tbody>
 
186
</table></div>
 
187
</div>
 
188
<hr>
 
189
<div class="refsect2" title="tp_svc_debug_implement_get_messages ()">
 
190
<a name="tp-svc-debug-implement-get-messages"></a><h3>tp_svc_debug_implement_get_messages ()</h3>
 
191
<pre class="programlisting">void                tp_svc_debug_implement_get_messages (<a class="link" href="telepathy-glib-svc-debug.html#TpSvcDebugClass" title="TpSvcDebugClass">TpSvcDebugClass</a> *klass,
 
192
                                                         <a class="link" href="telepathy-glib-svc-debug.html#tp-svc-debug-get-messages-impl" title="tp_svc_debug_get_messages_impl ()">tp_svc_debug_get_messages_impl</a> impl);</pre>
 
193
<p>
 
194
Register an implementation for the GetMessages method in the vtable
 
195
of an implementation of this interface. To be called from
 
196
the interface init function.</p>
 
197
<p>
 
198
</p>
 
199
<div class="variablelist"><table border="0">
 
200
<col align="left" valign="top">
 
201
<tbody>
 
202
<tr>
 
203
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
 
204
<td> A class whose instances implement this interface
 
205
</td>
 
206
</tr>
 
207
<tr>
 
208
<td><p><span class="term"><em class="parameter"><code>impl</code></em> :</span></p></td>
 
209
<td> A callback used to implement the GetMessages D-Bus method
 
210
</td>
 
211
</tr>
 
212
</tbody>
 
213
</table></div>
 
214
</div>
 
215
<hr>
 
216
<div class="refsect2" title="tp_svc_debug_return_from_get_messages ()">
 
217
<a name="tp-svc-debug-return-from-get-messages"></a><h3>tp_svc_debug_return_from_get_messages ()</h3>
 
218
<pre class="programlisting">void                tp_svc_debug_return_from_get_messages
 
219
                                                        (<a
 
220
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGMethod.html#DBusGMethodInvocation"
 
221
>DBusGMethodInvocation</a> *context,
 
222
                                                         const <a
 
223
href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"
 
224
>GPtrArray</a> *out_Messages);</pre>
 
225
<p>
 
226
Return successfully by calling <a
 
227
href="/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGMethod.html#dbus-g-method-return"
 
228
><code class="function">dbus_g_method_return()</code></a>.
 
229
This inline function exists only to provide type-safety.</p>
 
230
<p>
 
231
</p>
 
232
<div class="variablelist"><table border="0">
 
233
<col align="left" valign="top">
 
234
<tbody>
 
235
<tr>
 
236
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
 
237
<td> The D-Bus method invocation context
 
238
</td>
 
239
</tr>
 
240
<tr>
 
241
<td><p><span class="term"><em class="parameter"><code>out_Messages</code></em> :</span></p></td>
 
242
<td> const GPtrArray * (FIXME, generate documentation)
 
243
</td>
 
244
</tr>
 
245
</tbody>
 
246
</table></div>
 
247
</div>
 
248
<hr>
 
249
<div class="refsect2" title="tp_svc_debug_emit_new_debug_message ()">
 
250
<a name="tp-svc-debug-emit-new-debug-message"></a><h3>tp_svc_debug_emit_new_debug_message ()</h3>
 
251
<pre class="programlisting">void                tp_svc_debug_emit_new_debug_message (<a
 
252
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
 
253
>gpointer</a> instance,
 
254
                                                         <a
 
255
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
 
256
>gdouble</a> arg_time,
 
257
                                                         const <a
 
258
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
259
>gchar</a> *arg_domain,
 
260
                                                         <a
 
261
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
 
262
>guint</a> arg_level,
 
263
                                                         const <a
 
264
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
265
>gchar</a> *arg_message);</pre>
 
266
<p>
 
267
Type-safe wrapper around g_signal_emit to emit the
 
268
NewDebugMessage signal on interface org.freedesktop.Telepathy.Debug.</p>
 
269
<p>
 
270
</p>
 
271
<div class="variablelist"><table border="0">
 
272
<col align="left" valign="top">
 
273
<tbody>
 
274
<tr>
 
275
<td><p><span class="term"><em class="parameter"><code>instance</code></em> :</span></p></td>
 
276
<td> The object implementing this interface
 
277
</td>
 
278
</tr>
 
279
<tr>
 
280
<td><p><span class="term"><em class="parameter"><code>arg_time</code></em> :</span></p></td>
 
281
<td> gdouble  (FIXME, generate documentation)
 
282
</td>
 
283
</tr>
 
284
<tr>
 
285
<td><p><span class="term"><em class="parameter"><code>arg_domain</code></em> :</span></p></td>
 
286
<td> const gchar * (FIXME, generate documentation)
 
287
</td>
 
288
</tr>
 
289
<tr>
 
290
<td><p><span class="term"><em class="parameter"><code>arg_level</code></em> :</span></p></td>
 
291
<td> guint  (FIXME, generate documentation)
 
292
</td>
 
293
</tr>
 
294
<tr>
 
295
<td><p><span class="term"><em class="parameter"><code>arg_message</code></em> :</span></p></td>
 
296
<td> const gchar * (FIXME, generate documentation)
 
297
</td>
 
298
</tr>
 
299
</tbody>
 
300
</table></div>
 
301
</div>
 
302
</div>
 
303
<div class="refsect1" title="Signal Details">
 
304
<a name="telepathy-glib-svc-debug.signal-details"></a><h2>Signal Details</h2>
 
305
<div class="refsect2" title='The "new-debug-message" signal'>
 
306
<a name="TpSvcDebug-new-debug-message"></a><h3>The <code class="literal">"new-debug-message"</code> signal</h3>
 
307
<pre class="programlisting">void                user_function                      (<a class="link" href="telepathy-glib-svc-debug.html#TpSvcDebug">TpSvcDebug</a> *arg_time,
 
308
                                                        <a
 
309
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"
 
310
>gdouble</a>     arg_domain,
 
311
                                                        <a
 
312
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
313
>gchar</a>      *arg_level,
 
314
                                                        <a
 
315
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
 
316
>guint</a>       arg_message,
 
317
                                                        <a
 
318
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
319
>gchar</a>      *arg4,
 
320
                                                        <a
 
321
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
 
322
>gpointer</a>    user_data)        : Run Last / Has Details</pre>
 
323
<p>
 
324
The NewDebugMessage D-Bus signal is emitted whenever this GObject signal is.</p>
 
325
<p>
 
326
</p>
 
327
<div class="variablelist"><table border="0">
 
328
<col align="left" valign="top">
 
329
<tbody>
 
330
<tr>
 
331
<td><p><span class="term"><em class="parameter"><code>arg_time</code></em> :</span></p></td>
 
332
<td> gdouble  (FIXME, generate documentation)
 
333
</td>
 
334
</tr>
 
335
<tr>
 
336
<td><p><span class="term"><em class="parameter"><code>arg_domain</code></em> :</span></p></td>
 
337
<td> const gchar * (FIXME, generate documentation)
 
338
</td>
 
339
</tr>
 
340
<tr>
 
341
<td><p><span class="term"><em class="parameter"><code>arg_level</code></em> :</span></p></td>
 
342
<td> guint  (FIXME, generate documentation)
 
343
</td>
 
344
</tr>
 
345
<tr>
 
346
<td><p><span class="term"><em class="parameter"><code>arg_message</code></em> :</span></p></td>
 
347
<td> const gchar * (FIXME, generate documentation)
 
348
</td>
 
349
</tr>
 
350
<tr>
 
351
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
352
<td>user data set when the signal handler was connected.</td>
 
353
</tr>
 
354
</tbody>
 
355
</table></div>
 
356
</div>
 
357
</div>
 
358
</div>
 
359
<div class="footer">
 
360
<hr>
 
361
          Generated by GTK-Doc V1.11</div>
 
362
</body>
 
363
</html>