/usr/share/doc/libtelepathy-glib-doc/telepathy-glib/telepathy-glib-debug-sender.html is in libtelepathy-glib-doc 0.24.1-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpDebugSender: telepathy-glib API Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-utilities.html" title="Utilities">
<link rel="prev" href="telepathy-glib-debug.html" title="Common debug support">
<link rel="next" href="TpIntset.html" title="TpIntset">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#telepathy-glib-debug-sender.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#telepathy-glib-debug-sender.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#telepathy-glib-debug-sender.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#telepathy-glib-debug-sender.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch-utilities.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="telepathy-glib-debug.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="TpIntset.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="telepathy-glib-debug-sender"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-debug-sender.top_of_page"></a>TpDebugSender</span></h2>
<p>TpDebugSender — object for exposing Telepathy debug interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="telepathy-glib-debug-sender.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="returnvalue">TpDebugSender</span></a> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-debug-sender.html#tp-debug-sender-dup" title="tp_debug_sender_dup ()">tp_debug_sender_dup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-debug-sender.html#tp-debug-sender-add-message" title="tp_debug_sender_add_message ()">tp_debug_sender_add_message</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-debug-sender.html#tp-debug-sender-add-message-vprintf" title="tp_debug_sender_add_message_vprintf ()">tp_debug_sender_add_message_vprintf</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-debug-sender.html#tp-debug-sender-add-message-printf" title="tp_debug_sender_add_message_printf ()">tp_debug_sender_add_message_printf</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-debug-sender.html#tp-debug-sender-log-handler" title="tp_debug_sender_log_handler ()">tp_debug_sender_log_handler</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-debug-sender.html#tp-debug-sender-set-timestamps" title="tp_debug_sender_set_timestamps ()">tp_debug_sender_set_timestamps</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="telepathy-glib-debug-sender.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender--enabled" title="The “enabled” property">enabled</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<a name="TpDebugSender"></a><div class="refsect1">
<a name="telepathy-glib-debug-sender.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender-struct" title="struct TpDebugSender">TpDebugSender</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="telepathy-glib-debug-sender.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> TpDebugSender
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-debug-sender.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
TpDebugSender implements
<a class="link" href="telepathy-glib-svc-generic.html#TpSvcDBusProperties">TpSvcDBusProperties</a> and <a class="link" href="telepathy-glib-svc-debug.html#TpSvcDebug">TpSvcDebug</a>.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-debug-sender.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <telepathy-glib/telepathy-glib.h>
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-debug-sender.description"></a><h2>Description</h2>
<p>A <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> object is an object exposing the Telepathy debug interface.
There should be one object per process as it registers the object path
/org/freedesktop/Telepathy/debug. Once the object exists and has the object
path, messages can be passed to it using tp_debug_sender_add_message and
signals will automatically be fired.</p>
<p><a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> is primarily designed for use in Connection Managers, but can
be used by any other part of the Telepathy stack which wants to expose its
debugging information over the debug interface.</p>
<p>In a Connection Manager, one would probably keep a ref to the <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a>
in the connection manager object, and when this said object is finalized, so
is the process's <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a>. A GLib log handler is also provided:
<a class="link" href="telepathy-glib-debug-sender.html#tp-debug-sender-log-handler" title="tp_debug_sender_log_handler ()"><code class="function">tp_debug_sender_log_handler()</code></a>.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-debug-sender.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="tp-debug-sender-dup"></a><h3>tp_debug_sender_dup ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="returnvalue">TpDebugSender</span></a> *
tp_debug_sender_dup (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns a <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> instance on the bus this process was activated by
(if it was launched by D-Bus service activation), or the session bus
(otherwise).</p>
<p>The returned <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> is cached; the same <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> object will
be returned by this function repeatedly, as long as at least one reference
exists.</p>
<div class="refsect3">
<a name="id-1.8.6.11.2.6"></a><h4>Returns</h4>
<p> a reference to the <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> instance for the current starter
bus daemon</p>
</div>
<p class="since">Since: 0.7.36</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-debug-sender-add-message"></a><h3>tp_debug_sender_add_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_debug_sender_add_message (<em class="parameter"><code><a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GTimeVal</span> *timestamp</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *domain</code></em>,
<em class="parameter"><code><span class="type">GLogLevelFlags</span> level</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>);</pre>
<p>Adds a new message to the debug sender message queue. If the
<a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender--enabled" title="The “enabled” property"><span class="type">“enabled”</span></a> property is set to <code class="literal">TRUE</code>, then a NewDebugMessage
signal will be fired too.</p>
<div class="refsect3">
<a name="id-1.8.6.11.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timestamp</p></td>
<td class="parameter_description"><p>Time of the message or <code class="literal">NULL</code> for right now</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p>Message domain</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>level</p></td>
<td class="parameter_description"><p>The message level</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>string</p></td>
<td class="parameter_description"><p>The message string itself</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.7.36</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-debug-sender-add-message-vprintf"></a><h3>tp_debug_sender_add_message_vprintf ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_debug_sender_add_message_vprintf (<em class="parameter"><code><a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GTimeVal</span> *timestamp</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **formatted</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *domain</code></em>,
<em class="parameter"><code><span class="type">GLogLevelFlags</span> level</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre>
<p>Formats and adds a new message to the debug sender message queue. If the
<a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender--enabled" title="The “enabled” property"><span class="type">“enabled”</span></a> property is set to <code class="literal">TRUE</code>, then a NewDebugMessage
signal will be fired too.</p>
<div class="refsect3">
<a name="id-1.8.6.11.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timestamp</p></td>
<td class="parameter_description"><p>Time of the message, or <code class="literal">NULL</code> for right now</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>formatted</p></td>
<td class="parameter_description"><p>Place to store the formatted message, or <code class="literal">NULL</code> if not needed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p>Message domain</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>level</p></td>
<td class="parameter_description"><p>The message level</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>The <code class="function">printf()</code> format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>args</p></td>
<td class="parameter_description"><p>the <span class="type">va_list</span> of parameters to insert into <em class="parameter"><code>format</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.13.13</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-debug-sender-add-message-printf"></a><h3>tp_debug_sender_add_message_printf ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_debug_sender_add_message_printf (<em class="parameter"><code><a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GTimeVal</span> *timestamp</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **formatted</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *domain</code></em>,
<em class="parameter"><code><span class="type">GLogLevelFlags</span> level</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Formats and adds a new message to the debug sender message queue. If the
<a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender--enabled" title="The “enabled” property"><span class="type">“enabled”</span></a> property is set to <code class="literal">TRUE</code>, then a NewDebugMessage
signal will be fired too.</p>
<div class="refsect3">
<a name="id-1.8.6.11.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timestamp</p></td>
<td class="parameter_description"><p>Time of the message, or <code class="literal">NULL</code> for right now</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>formatted</p></td>
<td class="parameter_description"><p>Place to store the formatted message, or <code class="literal">NULL</code> if not required</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>domain</p></td>
<td class="parameter_description"><p>Message domain</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>level</p></td>
<td class="parameter_description"><p>The message level</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>The <code class="function">printf()</code> format string</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>The parameters to insert into <em class="parameter"><code>format</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.13.13</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-debug-sender-log-handler"></a><h3>tp_debug_sender_log_handler ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_debug_sender_log_handler (<em class="parameter"><code>const <span class="type">gchar</span> *log_domain</code></em>,
<em class="parameter"><code><span class="type">GLogLevelFlags</span> log_level</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *message</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> exclude</code></em>);</pre>
<p>A generic log handler designed to be used by CMs. It initially calls
<code class="function">g_log_default_handler()</code>, and then sends the message on the bus
<a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a>.</p>
<p>The <em class="parameter"><code>exclude</code></em>
parameter is designed to allow filtering one domain, instead of
sending every message to the <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a>: typical usage is for a
process to filter out messages from its own <code class="literal">G_LOG_DOMAIN</code>, so that it can
append a category to its own messages and pass them directly to
tp_debug_sender_add_message. Note that every message, regardless of
domain, is given to <code class="function">g_log_default_handler()</code>.</p>
<p>Note that a ref to a <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> must be kept at all times otherwise
no messages given to the handler will be sent to the Telepathy debug
interface.</p>
<p>An example of its usage, taking in mind the notes above, follows:</p>
<div class="informalexample"><pre class="programlisting">
/<!-- -->* Create a main loop and debug sender *<!-- -->/
GMainLoop *loop = g_main_loop_new (NULL, FALSE);
TpDebugSender *sender = tp_debug_sender_dup ();
/<!-- -->* Set the default handler *<!-- -->/
g_log_set_default_handler (tp_debug_sender_log_handler, G_LOG_DOMAIN);
/<!-- -->* Run the main loop, but keeping a ref on the TpDebugSender from
* the beginning of this code sample. *<!-- -->/
g_main_loop_run (loop);
/<!-- -->* g_main_loop_quit was called, so only now can we clean up the
* TpDebugSender. *<!-- -->/
g_object_unref (sender);
</pre></div>
<p></p>
<p>(In a connection manager, replace <code class="function">g_main_loop_run()</code> in the above example
with <a class="link" href="telepathy-glib-run.html#tp-run-connection-manager" title="tp_run_connection_manager ()"><code class="function">tp_run_connection_manager()</code></a>.)</p>
<p>This function is merely for convenience if it meets the requirements.
It can easily be re-implemented in services, and does not need to be
used.</p>
<p>If timestamps should be prepended to messages (like in
<a class="link" href="telepathy-glib-debug.html#tp-debug-timestamped-log-handler" title="tp_debug_timestamped_log_handler ()"><code class="function">tp_debug_timestamped_log_handler()</code></a>), <a class="link" href="telepathy-glib-debug-sender.html#tp-debug-sender-set-timestamps" title="tp_debug_sender_set_timestamps ()"><code class="function">tp_debug_sender_set_timestamps()</code></a>
should also be called.</p>
<p>Since version 0.11.15, this function can be called from any thread.</p>
<div class="refsect3">
<a name="id-1.8.6.11.6.14"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>log_domain</p></td>
<td class="parameter_description"><p>domain of the message</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>log_level</p></td>
<td class="parameter_description"><p>log leve of the message</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>the message itself</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>exclude</p></td>
<td class="parameter_description"><p>a log domain string to exclude from the <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.7.36</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-debug-sender-set-timestamps"></a><h3>tp_debug_sender_set_timestamps ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_debug_sender_set_timestamps (<em class="parameter"><code><a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> maybe</code></em>);</pre>
<p>If the log handler is <a class="link" href="telepathy-glib-debug-sender.html#tp-debug-sender-log-handler" title="tp_debug_sender_log_handler ()"><code class="function">tp_debug_sender_log_handler()</code></a> then calling
this function with <code class="literal">TRUE</code> on the debug sender will prepend the
message to be printed to stdout with the UTC time (currently in ISO
8601 format, with microsecond resolution). This is equivalent to
using <a class="link" href="telepathy-glib-debug.html#tp-debug-timestamped-log-handler" title="tp_debug_timestamped_log_handler ()"><code class="function">tp_debug_timestamped_log_handler()</code></a> as the log handler, but
also logging to the debug sender.</p>
<div class="refsect3">
<a name="id-1.8.6.11.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="telepathy-glib-debug-sender.html#TpDebugSender"><span class="type">TpDebugSender</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>maybe</p></td>
<td class="parameter_description"><p>whether to display message timestamps</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.15.5</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-debug-sender.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="TpDebugSender-struct"></a><h3>struct TpDebugSender</h3>
<pre class="programlisting">struct TpDebugSender;</pre>
<p>An object for exposing the Telepathy debug interface.</p>
<p class="since">Since: 0.7.36</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-debug-sender.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpDebugSender--enabled"></a><h3>The <code class="literal">“enabled”</code> property</h3>
<pre class="programlisting"> “enabled” <span class="type">gboolean</span></pre>
<p><code class="literal">TRUE</code> if the NewDebugMessage signal should be emitted when a new debug
message is generated.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|