/usr/share/gtk-doc/html/libinfinity-0.6/InfDiscovery.html is in libinfinity-0.6-doc 0.6.7-1build1.
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 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfDiscovery: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="libinfinity-0.6-InfAcl.html" title="Access Control Lists">
<link rel="next" href="InfLocalPublisher.html" title="InfLocalPublisher">
<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="#InfDiscovery.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfDiscovery.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#InfDiscovery.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#InfDiscovery.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfDiscovery.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libinfinity-0.6-InfAcl.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfLocalPublisher.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfDiscovery"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfDiscovery.top_of_page"></a>InfDiscovery</span></h2>
<p>InfDiscovery — Discovery of remote services</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfDiscovery.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfDiscovery.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">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="InfDiscovery.html#InfDiscoveryResolvCompleteFunc" title="InfDiscoveryResolvCompleteFunc ()">*InfDiscoveryResolvCompleteFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="InfDiscovery.html#InfDiscoveryResolvErrorFunc" title="InfDiscoveryResolvErrorFunc ()">*InfDiscoveryResolvErrorFunc</a><span class="c_punctuation">)</span> <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="InfDiscovery.html#inf-discovery-discover" title="inf_discovery_discover ()">inf_discovery_discover</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GSList</span> *
</td>
<td class="function_name">
<a class="link" href="InfDiscovery.html#inf-discovery-get-discovered" title="inf_discovery_get_discovered ()">inf_discovery_get_discovered</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="InfDiscovery.html#inf-discovery-resolve" title="inf_discovery_resolve ()">inf_discovery_resolve</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="InfDiscovery.html#inf-discovery-info-get-service-name" title="inf_discovery_info_get_service_name ()">inf_discovery_info_get_service_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="InfDiscovery.html#inf-discovery-info-get-service-type" title="inf_discovery_info_get_service_type ()">inf_discovery_info_get_service_type</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="InfDiscovery.html#inf-discovery-discovered" title="inf_discovery_discovered ()">inf_discovery_discovered</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="InfDiscovery.html#inf-discovery-undiscovered" title="inf_discovery_undiscovered ()">inf_discovery_undiscovered</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfDiscovery.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfDiscovery.html#InfDiscovery-discovered" title="The “discovered” signal">discovered</a></td>
<td class="signal_flags">Has Details</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfDiscovery.html#InfDiscovery-undiscovered" title="The “undiscovered” signal">undiscovered</a></td>
<td class="signal_flags">Has Details</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfDiscovery.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="InfDiscovery.html#InfDiscovery-struct" title="InfDiscovery">InfDiscovery</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfDiscovery.html#InfDiscoveryIface" title="struct InfDiscoveryIface">InfDiscoveryIface</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo">InfDiscoveryInfo</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfDiscovery.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GInterface
<span class="lineart">╰──</span> InfDiscovery
</pre>
</div>
<div class="refsect1">
<a name="InfDiscovery.prerequisites"></a><h2>Prerequisites</h2>
<p>
InfDiscovery requires
GObject.</p>
</div>
<div class="refsect1">
<a name="InfDiscovery.implementations"></a><h2>Known Implementations</h2>
<p>
InfDiscovery is implemented by
<a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi">InfDiscoveryAvahi</a>.</p>
</div>
<div class="refsect1">
<a name="InfDiscovery.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-discovery.h>
</pre>
</div>
<div class="refsect1">
<a name="InfDiscovery.description"></a><h2>Description</h2>
<p><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> provides a common interface for the discovery of services.
Discovered services are represented by <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> objects
and can be used to query the name of the discovered service.</p>
<p>To create a connection to the host providing a discovered service, use
<a class="link" href="InfDiscovery.html#inf-discovery-resolve" title="inf_discovery_resolve ()"><code class="function">inf_discovery_resolve()</code></a>.</p>
</div>
<div class="refsect1">
<a name="InfDiscovery.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="InfDiscoveryResolvCompleteFunc"></a><h3>InfDiscoveryResolvCompleteFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*InfDiscoveryResolvCompleteFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>This callback is called when a call to <a class="link" href="InfDiscovery.html#inf-discovery-resolve" title="inf_discovery_resolve ()"><code class="function">inf_discovery_resolve()</code></a> finished
successfully.</p>
<div class="refsect3">
<a name="id-1.3.14.12.2.5"></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>info</p></td>
<td class="parameter_description"><p>The resolved <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The resulting <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>The user_data passed to <a class="link" href="InfDiscovery.html#inf-discovery-resolve" title="inf_discovery_resolve ()"><code class="function">inf_discovery_resolve()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscoveryResolvErrorFunc"></a><h3>InfDiscoveryResolvErrorFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*InfDiscoveryResolvErrorFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>This callback is called when a call to <a class="link" href="InfDiscovery.html#inf-discovery-resolve" title="inf_discovery_resolve ()"><code class="function">inf_discovery_resolve()</code></a> failed.</p>
<div class="refsect3">
<a name="id-1.3.14.12.3.5"></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>info</p></td>
<td class="parameter_description"><p>The resolved <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Reason for the failure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>The user_data passed to <a class="link" href="InfDiscovery.html#inf-discovery-resolve" title="inf_discovery_resolve ()"><code class="function">inf_discovery_resolve()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-discovery-discover"></a><h3>inf_discovery_discover ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_discovery_discover (<em class="parameter"><code><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *type</code></em>);</pre>
<p>Starts the discovery of the given service type. Whenever a service of
this type is discovered, the "discovered" signal is emitted. If the
service disappears, the "undiscovered" signal is emitted. This can be
called more than once for the same type, but only the first call has
an effect.</p>
<p>Note also that implementations of <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> might restrict the
service types that can be discovered.</p>
<div class="refsect3">
<a name="id-1.3.14.12.4.6"></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>discovery</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>The service type to discover.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-discovery-get-discovered"></a><h3>inf_discovery_get_discovered ()</h3>
<pre class="programlisting"><span class="returnvalue">GSList</span> *
inf_discovery_get_discovered (<em class="parameter"><code><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *type</code></em>);</pre>
<p>Returns a list of discovered <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> for the given type.</p>
<div class="refsect3">
<a name="id-1.3.14.12.5.5"></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>discovery</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>The service type of which to get discovered infos for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.14.12.5.6"></a><h4>Returns</h4>
<p> A newly allocated list that needs to be freed with
<code class="function">g_slist_free()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-discovery-resolve"></a><h3>inf_discovery_resolve ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_discovery_resolve (<em class="parameter"><code><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
<em class="parameter"><code><a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>,
<em class="parameter"><code><a class="link" href="InfDiscovery.html#InfDiscoveryResolvCompleteFunc" title="InfDiscoveryResolvCompleteFunc ()"><span class="type">InfDiscoveryResolvCompleteFunc</span></a> complete_func</code></em>,
<em class="parameter"><code><a class="link" href="InfDiscovery.html#InfDiscoveryResolvErrorFunc" title="InfDiscoveryResolvErrorFunc ()"><span class="type">InfDiscoveryResolvErrorFunc</span></a> error_func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Attempts to resolve <em class="parameter"><code>info</code></em>
. Resolving a <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> means creating
a <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> to the publisher. The connection might not be
open when <em class="parameter"><code>complete_func</code></em>
runs. This will call either <em class="parameter"><code>complete_func</code></em>
or <em class="parameter"><code>error_func</code></em>
, but not both.</p>
<div class="refsect3">
<a name="id-1.3.14.12.6.5"></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>discovery</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> discovered by <em class="parameter"><code>discovery</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>complete_func</p></td>
<td class="parameter_description"><p>A callback that will be called when the resolving process
has completed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error_func</p></td>
<td class="parameter_description"><p>A callback that will be called when an error has occured.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Extra data to pass to <em class="parameter"><code>complete_func</code></em>
and <em class="parameter"><code>error_func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-discovery-info-get-service-name"></a><h3>inf_discovery_info_get_service_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
inf_discovery_info_get_service_name (<em class="parameter"><code><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
<em class="parameter"><code><a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>);</pre>
<p>Returns the service name of the discovered <em class="parameter"><code>info</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.14.12.7.5"></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>discovery</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> discovered by <em class="parameter"><code>discovery</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.14.12.7.6"></a><h4>Returns</h4>
<p> A string owned by <em class="parameter"><code>discovery</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-discovery-info-get-service-type"></a><h3>inf_discovery_info_get_service_type ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
inf_discovery_info_get_service_type (<em class="parameter"><code><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
<em class="parameter"><code><a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>);</pre>
<p>Returns the service type of the discovered <em class="parameter"><code>info</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.14.12.8.5"></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>discovery</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> discovered by <em class="parameter"><code>discovery</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.14.12.8.6"></a><h4>Returns</h4>
<p> A string owned by <em class="parameter"><code>discovery</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-discovery-discovered"></a><h3>inf_discovery_discovered ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_discovery_discovered (<em class="parameter"><code><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
<em class="parameter"><code><a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>);</pre>
<p>Emits the "discovered" signal on <em class="parameter"><code>discovery</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.14.12.9.5"></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>discovery</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>The discovered <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-discovery-undiscovered"></a><h3>inf_discovery_undiscovered ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_discovery_undiscovered (<em class="parameter"><code><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> *discovery</code></em>,
<em class="parameter"><code><a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> *info</code></em>);</pre>
<p>Emits the "undiscovered" signal on <em class="parameter"><code>discovery</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.14.12.10.5"></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>discovery</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>The undiscovered <em class="parameter"><code>InfDiscoveryInfo</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfDiscovery.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfDiscovery-struct"></a><h3>InfDiscovery</h3>
<pre class="programlisting">typedef struct _InfDiscovery InfDiscovery;</pre>
<p><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> is an opaque data type. You should only access it
via the public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscoveryIface"></a><h3>struct InfDiscoveryIface</h3>
<pre class="programlisting">struct InfDiscoveryIface {
void (*discover)(InfDiscovery* discovery,
const gchar* type);
GSList* (*get_discovered)(InfDiscovery* discovery,
const gchar* type);
void (*resolve)(InfDiscovery* discovery,
InfDiscoveryInfo* info,
InfDiscoveryResolvCompleteFunc complete_func,
InfDiscoveryResolvErrorFunc error_func,
gpointer user_data);
gchar*(*info_get_service_name)(InfDiscovery* discovery,
InfDiscoveryInfo* info);
const gchar*(*info_get_service_type)(InfDiscovery* discovery,
InfDiscoveryInfo* info);
/* Signals */
void (*discovered)(InfDiscovery* discovery,
InfDiscoveryInfo* info);
void (*undiscovered)(InfDiscovery* discovery,
InfDiscoveryInfo* info);
};
</pre>
<p>The virtual methods and default signal handlers of <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>.
Implementing these allows discovering infinote servers.</p>
<div class="refsect3">
<a name="id-1.3.14.13.3.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfDiscoveryIface.discover"></a>discover</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to start discovery of services of the given
type. If the discovery was already started ealier, then this function does
nothing.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfDiscoveryIface.get-discovered"></a>get_discovered</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to retrieve a list of
<a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a>s that represent discovered services.
It needs to be freed by the caller via <code class="function">g_slist_free()</code>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfDiscoveryIface.resolve"></a>resolve</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function that attempts to resolve the given discovery
info. It guarantees to either call <em class="parameter"><code>complete_func</code></em>
or <em class="parameter"><code>error_func</code></em>
when the
process has finished.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfDiscoveryIface.info-get-service-name"></a>info_get_service_name</code></em> ()</p></td>
<td class="struct_member_description"><p>Returns the service name of the given
<a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> as a new string, to be freed by the caller with <code class="function">g_free()</code>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfDiscoveryIface.info-get-service-type"></a>info_get_service_type</code></em> ()</p></td>
<td class="struct_member_description"><p>Returns the type of the discovered service of the
given <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> as a static string.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfDiscoveryIface.discovered"></a>discovered</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the <a class="link" href="InfDiscovery.html#InfDiscovery-discovered" title="The “discovered” signal"><span class="type">“discovered”</span></a>
signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfDiscoveryIface.undiscovered"></a>undiscovered</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the <a class="link" href="InfDiscovery.html#InfDiscovery-undiscovered" title="The “undiscovered” signal"><span class="type">“undiscovered”</span></a>
signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscoveryInfo"></a><h3>InfDiscoveryInfo</h3>
<pre class="programlisting">typedef struct _InfDiscoveryInfo InfDiscoveryInfo;</pre>
<p><a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> is an opaque data type. You should only access it
via the public API functions.</p>
</div>
</div>
<div class="refsect1">
<a name="InfDiscovery.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfDiscovery-discovered"></a><h3>The <code class="literal">“discovered”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> *discoverer,
<span class="type">gpointer</span> info,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is detailed. The detail is the name of the service that has
been discovered, so you can connect to
"discovered::<span class="emphasis"><em>my-service-name</em></span>" if you are
only interested in a particular service.</p>
<div class="refsect3">
<a name="id-1.3.14.14.2.5"></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>discoverer</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> object discovering something</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> describing the discovered service</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Has Details</p>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscovery-undiscovered"></a><h3>The <code class="literal">“undiscovered”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> *discoverer,
<span class="type">gpointer</span> info,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted if a previously discovered service is no longer
available.</p>
<p>This signal is detailed. The detail is the name of the service that has
been undiscovered, so you can connect to
"undiscovered::<span class="emphasis"><em>my-service-name</em></span>" if you
are only interested in a particular service.</p>
<div class="refsect3">
<a name="id-1.3.14.14.3.6"></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>discoverer</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> object undiscovering something</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>info</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> describing the undiscovered service</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Has Details</p>
</div>
</div>
<div class="refsect1">
<a name="InfDiscovery.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|