/usr/share/doc/libtelepathy-glib-doc/telepathy-glib/telepathy-glib-gnio-util.html is in libtelepathy-glib-doc 0.24.1-2.
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 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GNIO Utilities: telepathy-glib API Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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-util.html" title="Utilities">
<link rel="next" href="telepathy-glib-debug.html" title="Common debug support">
<meta name="generator" content="GTK-Doc V1.25 (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-gnio-util.description" class="shortcut">Description</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-util.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="telepathy-glib-debug.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="telepathy-glib-gnio-util"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-gnio-util.top_of_page"></a>GNIO Utilities</span></h2>
<p>GNIO Utilities — Telepathy/GNIO utility functions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="telepathy-glib-gnio-util.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GSocketAddress</span> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-gnio-util.html#tp-g-socket-address-from-variant" title="tp_g_socket_address_from_variant ()">tp_g_socket_address_from_variant</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GValue</span> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-gnio-util.html#tp-address-variant-from-g-socket-address" title="tp_address_variant_from_g_socket_address ()">tp_address_variant_from_g_socket_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GSocketAddress</span> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-gnio-util.html#tp-g-socket-address-from-g-variant" title="tp_g_socket_address_from_g_variant ()">tp_g_socket_address_from_g_variant</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GVariant</span> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-gnio-util.html#tp-address-g-variant-from-g-socket-address" title="tp_address_g_variant_from_g_socket_address ()">tp_address_g_variant_from_g_socket_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GCredentials</span> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-receive-credentials-with-byte" title="tp_unix_connection_receive_credentials_with_byte ()">tp_unix_connection_receive_credentials_with_byte</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-gnio-util.html#tp-unix-connection-receive-credentials-with-byte-async" title="tp_unix_connection_receive_credentials_with_byte_async ()">tp_unix_connection_receive_credentials_with_byte_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GCredentials</span> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-receive-credentials-with-byte-finish" title="tp_unix_connection_receive_credentials_with_byte_finish ()">tp_unix_connection_receive_credentials_with_byte_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-send-credentials-with-byte" title="tp_unix_connection_send_credentials_with_byte ()">tp_unix_connection_send_credentials_with_byte</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-gnio-util.html#tp-unix-connection-send-credentials-with-byte-async" title="tp_unix_connection_send_credentials_with_byte_async ()">tp_unix_connection_send_credentials_with_byte_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-send-credentials-with-byte-finish" title="tp_unix_connection_send_credentials_with_byte_finish ()">tp_unix_connection_send_credentials_with_byte_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="telepathy-glib-gnio-util.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <telepathy-glib/telepathy-glib.h>
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-gnio-util.description"></a><h2>Description</h2>
<p>Utility functions for interacting between Telepathy and GNIO.</p>
<p>Telepathy uses address variants stored in <span class="type">GValue</span> boxes for communicating
network socket addresses over D-Bus to and from the Connection Manager
(for instance when using the file transfer and stream tube APIs).</p>
<p>This API provides translation between <span class="type">GSocketAddress</span> subtypes and a <span class="type">GValue</span>
that can be used by telepathy-glib.
<span class="type">GInetSocketAddress</span> is used for IPv4/IPv6 and <span class="type">GUnixSocketAddress</span>
for UNIX sockets (only available on platforms with gio-unix).</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-gnio-util.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="tp-g-socket-address-from-variant"></a><h3>tp_g_socket_address_from_variant ()</h3>
<pre class="programlisting"><span class="returnvalue">GSocketAddress</span> *
tp_g_socket_address_from_variant (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpSocketAddressType" title="enum TpSocketAddressType"><span class="type">TpSocketAddressType</span></a> type</code></em>,
<em class="parameter"><code>const <span class="type">GValue</span> *variant</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Converts an address variant stored in a <span class="type">GValue</span> into a <span class="type">GSocketAddress</span> that
can be used to make a socket connection with GIO.</p>
<div class="refsect3">
<a name="tp-g-socket-address-from-variant.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>type</p></td>
<td class="parameter_description"><p>a Telepathy socket address type</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>variant</p></td>
<td class="parameter_description"><p>an initialised <span class="type">GValue</span> containing an address variant,
as encoded by dbus-glib</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span> (or NULL)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-g-socket-address-from-variant.returns"></a><h4>Returns</h4>
<p> a newly allocated <span class="type">GSocketAddress</span> for the given variant, or NULL
on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-address-variant-from-g-socket-address"></a><h3>tp_address_variant_from_g_socket_address ()</h3>
<pre class="programlisting"><span class="returnvalue">GValue</span> *
tp_address_variant_from_g_socket_address
(<em class="parameter"><code><span class="type">GSocketAddress</span> *address</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpSocketAddressType" title="enum TpSocketAddressType"><span class="type">TpSocketAddressType</span></a> *type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Converts a <span class="type">GSocketAddress</span> to a <span class="type">GValue</span> address variant that can be used
with Telepathy and dbus-glib.</p>
<div class="refsect3">
<a name="tp-address-variant-from-g-socket-address.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>address</p></td>
<td class="parameter_description"><p>a <span class="type">GSocketAddress</span> to convert</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>optional return of the Telepathy socket type (or NULL)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span> (or NULL)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-address-variant-from-g-socket-address.returns"></a><h4>Returns</h4>
<p> a newly allocated <span class="type">GValue</span>, free with <a class="link" href="telepathy-glib-util.html#tp-g-value-slice-free" title="tp_g_value_slice_free ()"><code class="function">tp_g_value_slice_free()</code></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-g-socket-address-from-g-variant"></a><h3>tp_g_socket_address_from_g_variant ()</h3>
<pre class="programlisting"><span class="returnvalue">GSocketAddress</span> *
tp_g_socket_address_from_g_variant (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpSocketAddressType" title="enum TpSocketAddressType"><span class="type">TpSocketAddressType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GVariant</span> *variant</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Converts an address variant stored in a <span class="type">GVariant</span> into a <span class="type">GSocketAddress</span>
that can be used to make a socket connection with GIO.</p>
<p>If <em class="parameter"><code>variant</code></em>
is a floating reference, this function takes ownership
of it.</p>
<div class="refsect3">
<a name="tp-g-socket-address-from-g-variant.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>type</p></td>
<td class="parameter_description"><p>a Telepathy socket address type</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>variant</p></td>
<td class="parameter_description"><p>a socket address as encoded by Telepathy according to <em class="parameter"><code>type</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span> (or <code class="literal">NULL</code>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-g-socket-address-from-g-variant.returns"></a><h4>Returns</h4>
<p> a newly allocated <span class="type">GSocketAddress</span> for the given variant, or <code class="literal">NULL</code>
on error</p>
</div>
<p class="since">Since: 0.19.10</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-address-g-variant-from-g-socket-address"></a><h3>tp_address_g_variant_from_g_socket_address ()</h3>
<pre class="programlisting"><span class="returnvalue">GVariant</span> *
tp_address_g_variant_from_g_socket_address
(<em class="parameter"><code><span class="type">GSocketAddress</span> *address</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpSocketAddressType" title="enum TpSocketAddressType"><span class="type">TpSocketAddressType</span></a> *type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Converts a <span class="type">GSocketAddress</span> to a <span class="type">GVariant</span> address variant that can be used
with Telepathy.</p>
<div class="refsect3">
<a name="tp-address-g-variant-from-g-socket-address.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>address</p></td>
<td class="parameter_description"><p>a <span class="type">GSocketAddress</span> to convert</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>optional return of the Telepathy socket type (or NULL)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span> (or NULL)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-address-g-variant-from-g-socket-address.returns"></a><h4>Returns</h4>
<p> a new variant with a floating reference, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.19.10</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-unix-connection-receive-credentials-with-byte"></a><h3>tp_unix_connection_receive_credentials_with_byte ()</h3>
<pre class="programlisting"><span class="returnvalue">GCredentials</span> *
tp_unix_connection_receive_credentials_with_byte
(<em class="parameter"><code><span class="type">GSocketConnection</span> *connection</code></em>,
<em class="parameter"><code><span class="type">guchar</span> *byte</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>A variant of <code class="function">g_unix_connection_receive_credentials()</code> allowing you to get
the byte which has been received with the credentials.</p>
<div class="refsect3">
<a name="tp-unix-connection-receive-credentials-with-byte.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>connection</p></td>
<td class="parameter_description"><p>a <span class="type">GUnixConnection</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>byte</p></td>
<td class="parameter_description"><p> if not <code class="literal">NULL</code>, used to return the byte. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <span class="type">GCancellable</span>, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> to fill</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-unix-connection-receive-credentials-with-byte.returns"></a><h4>Returns</h4>
<p> Received credentials on success (free with
<code class="function">g_object_unref()</code>), <code class="literal">NULL</code> if error is set. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-unix-connection-receive-credentials-with-byte-async"></a><h3>tp_unix_connection_receive_credentials_with_byte_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_unix_connection_receive_credentials_with_byte_async
(<em class="parameter"><code><span class="type">GSocketConnection</span> *connection</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Asynchronously receive credentials.</p>
<p>For more details, see <a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-receive-credentials-with-byte" title="tp_unix_connection_receive_credentials_with_byte ()"><code class="function">tp_unix_connection_receive_credentials_with_byte()</code></a>
which is the synchronous version of this call.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
will be called. You can then call
<a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-receive-credentials-with-byte-finish" title="tp_unix_connection_receive_credentials_with_byte_finish ()"><code class="function">tp_unix_connection_receive_credentials_with_byte_finish()</code></a> to get the result
of the operation.</p>
<div class="refsect3">
<a name="tp-unix-connection-receive-credentials-with-byte-async.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>connection</p></td>
<td class="parameter_description"><p>A <span class="type">GUnixConnection</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <span class="type">GCancellable</span> object, <code class="literal">NULL</code> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p> a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p> the data to pass to callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-unix-connection-receive-credentials-with-byte-finish"></a><h3>tp_unix_connection_receive_credentials_with_byte_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">GCredentials</span> *
tp_unix_connection_receive_credentials_with_byte_finish
(<em class="parameter"><code><span class="type">GSocketConnection</span> *connection</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">guchar</span> *byte</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Finishes an asynchronous receive credentials operation started with
<a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-receive-credentials-with-byte-async" title="tp_unix_connection_receive_credentials_with_byte_async ()"><code class="function">tp_unix_connection_receive_credentials_with_byte_async()</code></a>.</p>
<div class="refsect3">
<a name="tp-unix-connection-receive-credentials-with-byte-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>connection</p></td>
<td class="parameter_description"><p>A <span class="type">GUnixConnection</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncResult</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>byte</p></td>
<td class="parameter_description"><p> if not <code class="literal">NULL</code>, used to return the byte. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-unix-connection-receive-credentials-with-byte-finish.returns"></a><h4>Returns</h4>
<p> a <span class="type">GCredentials</span>, or <code class="literal">NULL</code> on error.
Free the returned object with <code class="function">g_object_unref()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-unix-connection-send-credentials-with-byte"></a><h3>tp_unix_connection_send_credentials_with_byte ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
tp_unix_connection_send_credentials_with_byte
(<em class="parameter"><code><span class="type">GSocketConnection</span> *connection</code></em>,
<em class="parameter"><code><span class="type">guchar</span> byte</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>A variant of <code class="function">g_unix_connection_send_credentials()</code> allowing you to choose
the byte which is send with the credentials</p>
<div class="refsect3">
<a name="tp-unix-connection-send-credentials-with-byte.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>connection</p></td>
<td class="parameter_description"><p>a <span class="type">GUnixConnection</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>byte</p></td>
<td class="parameter_description"><p>the byte to send with the credentials</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <span class="type">GCancellable</span>, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span> to fill</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-unix-connection-send-credentials-with-byte.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if error is set.</p>
</div>
<p class="since">Since: 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-unix-connection-send-credentials-with-byte-async"></a><h3>tp_unix_connection_send_credentials_with_byte_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tp_unix_connection_send_credentials_with_byte_async
(<em class="parameter"><code><span class="type">GSocketConnection</span> *connection</code></em>,
<em class="parameter"><code><span class="type">guchar</span> byte</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Asynchronously send credentials.</p>
<p>For more details, see <a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-send-credentials-with-byte" title="tp_unix_connection_send_credentials_with_byte ()"><code class="function">tp_unix_connection_send_credentials_with_byte()</code></a> which
is the synchronous version of this call.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
will be called. You can then call
<a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-send-credentials-with-byte-finish" title="tp_unix_connection_send_credentials_with_byte_finish ()"><code class="function">tp_unix_connection_send_credentials_with_byte_finish()</code></a> to get the result of
the operation.</p>
<div class="refsect3">
<a name="tp-unix-connection-send-credentials-with-byte-async.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>connection</p></td>
<td class="parameter_description"><p>A <span class="type">GUnixConnection</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>byte</p></td>
<td class="parameter_description"><p>the byte to send with the credentials</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <span class="type">GCancellable</span> object, <code class="literal">NULL</code> to ignore. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p> a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p> the data to pass to callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.17.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-unix-connection-send-credentials-with-byte-finish"></a><h3>tp_unix_connection_send_credentials_with_byte_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
tp_unix_connection_send_credentials_with_byte_finish
(<em class="parameter"><code><span class="type">GSocketConnection</span> *connection</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Finishes an asynchronous send credentials operation started with
<a class="link" href="telepathy-glib-gnio-util.html#tp-unix-connection-send-credentials-with-byte-async" title="tp_unix_connection_send_credentials_with_byte_async ()"><code class="function">tp_unix_connection_send_credentials_with_byte_async()</code></a>.</p>
<div class="refsect3">
<a name="tp-unix-connection-send-credentials-with-byte-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>connection</p></td>
<td class="parameter_description"><p>A <span class="type">GUnixConnection</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncResult</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-unix-connection-send-credentials-with-byte-finish.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the operation was successful, otherwise <code class="literal">FALSE</code>.</p>
</div>
<p class="since">Since: 0.17.5</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-gnio-util.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|