/usr/share/gtk-doc/html/libinfinoted-plugin-manager-0.6/InfinotedPluginManager.html is in libinfinity-0.6-doc 0.6.7-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 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 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfinotedPluginManager: libinfinoted-plugin-manager-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinoted-plugin-manager-0.6 Reference Manual">
<link rel="up" href="ch01.html" title="libinfinoted-plugin-manager API reference">
<link rel="prev" href="ch01.html" title="libinfinoted-plugin-manager API reference">
<link rel="next" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html" title="InfinotedParameter">
<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="#InfinotedPluginManager.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfinotedPluginManager.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfinotedPluginManager.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfinotedPluginManager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfinotedPluginManager.top_of_page"></a>InfinotedPluginManager</span></h2>
<p>InfinotedPluginManager — Loads and propagates events to infinoted plugins.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfinotedPluginManager.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="InfinotedPluginManager.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">
<a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="returnvalue">InfinotedPluginManager</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-new" title="infinoted_plugin_manager_new ()">infinoted_plugin_manager_new</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="InfinotedPluginManager.html#infinoted-plugin-manager-load" title="infinoted_plugin_manager_load ()">infinoted_plugin_manager_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="returnvalue">InfdDirectory</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-get-directory" title="infinoted_plugin_manager_get_directory ()">infinoted_plugin_manager_get_directory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/InfIo.html#InfIo-struct"><span class="returnvalue">InfIo</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-get-io" title="infinoted_plugin_manager_get_io ()">infinoted_plugin_manager_get_io</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfinotedLog.html" title="InfinotedLog"><span class="returnvalue">InfinotedLog</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-get-log" title="infinoted_plugin_manager_get_log ()">infinoted_plugin_manager_get_log</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/InfCertificateCredentials.html#InfCertificateCredentials-struct"><span class="returnvalue">InfCertificateCredentials</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-get-credentials" title="infinoted_plugin_manager_get_credentials ()">infinoted_plugin_manager_get_credentials</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gpointer</span>
</td>
<td class="function_name">
<a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-get-connection-info" title="infinoted_plugin_manager_get_connection_info ()">infinoted_plugin_manager_get_connection_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gpointer</span>
</td>
<td class="function_name">
<a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-get-session-info" title="infinoted_plugin_manager_get_session_info ()">infinoted_plugin_manager_get_session_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GQuark</span>
</td>
<td class="function_name">
<a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-error-quark" title="infinoted_plugin_manager_error_quark ()">infinoted_plugin_manager_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfinotedPluginManager.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" 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">
<a href="../html/InfCertificateCredentials.html#InfCertificateCredentials-struct"><span class="type">InfCertificateCredentials</span></a> *</td>
<td class="property_name"><a class="link" href="InfinotedPluginManager.html#InfinotedPluginManager--credentials" title="The “credentials” property">credentials</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="type">InfdDirectory</span></a> *</td>
<td class="property_name"><a class="link" href="InfinotedPluginManager.html#InfinotedPluginManager--directory" title="The “directory” property">directory</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfinotedLog.html" title="InfinotedLog"><span class="type">InfinotedLog</span></a> *</td>
<td class="property_name"><a class="link" href="InfinotedPluginManager.html#InfinotedPluginManager--log" title="The “log” property">log</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfinotedPluginManager.html#InfinotedPluginManager--path" title="The “path” property">path</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfinotedPluginManager.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">struct</td>
<td class="function_name"><a class="link" href="InfinotedPluginManager.html#InfinotedPluginManager-struct" title="struct InfinotedPluginManager">InfinotedPluginManager</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfinotedPluginManager.html#InfinotedPluginManagerClass" title="struct InfinotedPluginManagerClass">InfinotedPluginManagerClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfinotedPluginManager.html#InfinotedPlugin" title="struct InfinotedPlugin">InfinotedPlugin</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfinotedPluginManager.html#InfinotedPluginManagerError" title="enum InfinotedPluginManagerError">InfinotedPluginManagerError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfinotedPluginManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfinotedPluginManager
</pre>
</div>
<div class="refsect1">
<a name="InfinotedPluginManager.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <infinoted/infinoted-plugin-manager.h>
</pre>
</div>
<div class="refsect1">
<a name="InfinotedPluginManager.description"></a><h2>Description</h2>
<p><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a> handles the loading of plugins for the infinoted
server. It initializes and deinitializes plugins, and it makes callbacks
when connections or sessions are added or removed. Furthermore, it provides
an interface for plugins to obtain and interact with the server itself,
most notable its <a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="type">InfdDirectory</span></a> instance.</p>
</div>
<div class="refsect1">
<a name="InfinotedPluginManager.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="infinoted-plugin-manager-new"></a><h3>infinoted_plugin_manager_new ()</h3>
<pre class="programlisting"><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="returnvalue">InfinotedPluginManager</span></a> *
infinoted_plugin_manager_new (<em class="parameter"><code><a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="type">InfdDirectory</span></a> *directory</code></em>,
<em class="parameter"><code><a class="link" href="InfinotedLog.html" title="InfinotedLog"><span class="type">InfinotedLog</span></a> *log</code></em>,
<em class="parameter"><code><a href="../html/InfCertificateCredentials.html#InfCertificateCredentials-struct"><span class="type">InfCertificateCredentials</span></a> *creds</code></em>);</pre>
<p>Creates a new <a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a> with the given directory, log
and credentials. These three objects will be available for plugins
to enhance the infinoted functionality. Plugins can be loaded
with <a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-load" title="infinoted_plugin_manager_load ()"><code class="function">infinoted_plugin_manager_load()</code></a>.</p>
<div class="refsect3">
<a name="infinoted-plugin-manager-new.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>directory</p></td>
<td class="parameter_description"><p>The <a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="type">InfdDirectory</span></a> on which plugins should operate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>log</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfinotedLog.html" title="InfinotedLog"><span class="type">InfinotedLog</span></a> to write log messages to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>creds</p></td>
<td class="parameter_description"><p>The <a href="../html/InfCertificateCredentials.html#InfCertificateCredentials-struct"><span class="type">InfCertificateCredentials</span></a> used to secure data transfer with
the clients, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-plugin-manager-new.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-plugin-manager-load"></a><h3>infinoted_plugin_manager_load ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_plugin_manager_load (<em class="parameter"><code><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a> *manager</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *plugin_path</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> * const*plugins</code></em>,
<em class="parameter"><code><span class="type">GKeyFile</span> *options</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Loads all plugins specified in <em class="parameter"><code>plugins</code></em>
from the location at <em class="parameter"><code>plugin_path</code></em>
.
If loading one of the module fails the function sets <em class="parameter"><code>error</code></em>
and returns
<code class="literal">FALSE</code>, and the object ends up with no plugins loaded. If <em class="parameter"><code>plugins</code></em>
is
<code class="literal">NULL</code>, no plugins are loaded.</p>
<p>If this function is called while there are already plugins loaded, all
existing plugins are unloaded first.</p>
<div class="refsect3">
<a name="infinoted-plugin-manager-load.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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>plugin_path</p></td>
<td class="parameter_description"><p>The path from which to load plugins.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>plugins</p></td>
<td class="parameter_description"><p>A list of plugins to load, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>options</p></td>
<td class="parameter_description"><p>A <span class="type">GKeyFile</span> with configuration options for the plugins.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-plugin-manager-load.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-plugin-manager-get-directory"></a><h3>infinoted_plugin_manager_get_directory ()</h3>
<pre class="programlisting"><a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="returnvalue">InfdDirectory</span></a> *
infinoted_plugin_manager_get_directory
(<em class="parameter"><code><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a> *manager</code></em>);</pre>
<p>Returns the <a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="type">InfdDirectory</span></a> used by the plugin manager.</p>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-directory.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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-directory.returns"></a><h4>Returns</h4>
<p> A <a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="type">InfdDirectory</span></a> owned by the plugin manager.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-plugin-manager-get-io"></a><h3>infinoted_plugin_manager_get_io ()</h3>
<pre class="programlisting"><a href="../html/InfIo.html#InfIo-struct"><span class="returnvalue">InfIo</span></a> *
infinoted_plugin_manager_get_io (<em class="parameter"><code><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a> *manager</code></em>);</pre>
<p>Returns the <a href="../html/InfIo.html#InfIo-struct"><span class="type">InfIo</span></a> of the <a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="type">InfdDirectory</span></a> used by the plugin manager.</p>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-io.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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-io.returns"></a><h4>Returns</h4>
<p> A <a href="../html/InfIo.html#InfIo-struct"><span class="type">InfIo</span></a> owned by the plugin manager.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-plugin-manager-get-log"></a><h3>infinoted_plugin_manager_get_log ()</h3>
<pre class="programlisting"><a class="link" href="InfinotedLog.html" title="InfinotedLog"><span class="returnvalue">InfinotedLog</span></a> *
infinoted_plugin_manager_get_log (<em class="parameter"><code><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a> *manager</code></em>);</pre>
<p>Returns the <a class="link" href="InfinotedLog.html" title="InfinotedLog"><span class="type">InfinotedLog</span></a> that the plugin manager and the plugins do
write log messages to.</p>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-log.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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-log.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfinotedLog.html" title="InfinotedLog"><span class="type">InfinotedLog</span></a> owned by the plugin manager.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-plugin-manager-get-credentials"></a><h3>infinoted_plugin_manager_get_credentials ()</h3>
<pre class="programlisting"><a href="../html/InfCertificateCredentials.html#InfCertificateCredentials-struct"><span class="returnvalue">InfCertificateCredentials</span></a> *
infinoted_plugin_manager_get_credentials
(<em class="parameter"><code><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a> *manager</code></em>);</pre>
<p>Returns the <a href="../html/InfCertificateCredentials.html#InfCertificateCredentials-struct"><span class="type">InfCertificateCredentials</span></a> used for securing the data transfer
with all clients.</p>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-credentials.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>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-credentials.returns"></a><h4>Returns</h4>
<p> A <a href="../html/InfCertificateCredentials.html#InfCertificateCredentials-struct"><span class="type">InfCertificateCredentials</span></a> object owned by the plugin manager.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-plugin-manager-get-connection-info"></a><h3>infinoted_plugin_manager_get_connection_info ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span>
infinoted_plugin_manager_get_connection_info
(<em class="parameter"><code><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a> *mgr</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> plugin_info</code></em>,
<em class="parameter"><code><a href="../html/InfXmlConnection.html#InfXmlConnection-struct"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Queries the connection-specfic plugin data for the plugin instance
<em class="parameter"><code>plugin_info</code></em>
. Returns <code class="literal">NULL</code> if no such object exists, i.e. when the
plugin's <em class="parameter"><code>connection_info_size</code></em>
is set to 0.</p>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-connection-info.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>mgr</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>plugin_info</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>plugin_info</code></em>
pointer of a plugin instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The <a href="../html/InfXmlConnection.html#InfXmlConnection-struct"><span class="type">InfXmlConnection</span></a> for which to retrieve plugin data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-connection-info.returns"></a><h4>Returns</h4>
<p> A pointer to the connection-specific plugin data, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-plugin-manager-get-session-info"></a><h3>infinoted_plugin_manager_get_session_info ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span>
infinoted_plugin_manager_get_session_info
(<em class="parameter"><code><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a> *mgr</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> plugin_info</code></em>,
<em class="parameter"><code><a href="../html/InfSessionProxy.html#InfSessionProxy-struct"><span class="type">InfSessionProxy</span></a> *proxy</code></em>);</pre>
<p>Queries the session-specfic plugin data for the plugin instance
<em class="parameter"><code>plugin_info</code></em>
. Returns <code class="literal">NULL</code> if no such object exists, i.e. when the
plugin's <em class="parameter"><code>session_info_size</code></em>
is set to 0.</p>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-session-info.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>mgr</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>plugin_info</p></td>
<td class="parameter_description"><p>The <em class="parameter"><code>plugin_info</code></em>
pointer of a plugin instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>proxy</p></td>
<td class="parameter_description"><p>The <a href="../html/InfSessionProxy.html#InfSessionProxy-struct"><span class="type">InfSessionProxy</span></a> for which to retrieve plugin data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-plugin-manager-get-session-info.returns"></a><h4>Returns</h4>
<p> A pointer to the session-specific plugin data, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-plugin-manager-error-quark"></a><h3>infinoted_plugin_manager_error_quark ()</h3>
<pre class="programlisting"><span class="returnvalue">GQuark</span>
infinoted_plugin_manager_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the <span class="type">GQuark</span> for errors from the InfinotedPluginManager module.</p>
<div class="refsect3">
<a name="infinoted-plugin-manager-error-quark.returns"></a><h4>Returns</h4>
<p> The error domain for the InfinotedPluginManager module.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfinotedPluginManager.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfinotedPluginManager-struct"></a><h3>struct InfinotedPluginManager</h3>
<pre class="programlisting">struct InfinotedPluginManager;</pre>
<p><a class="link" href="InfinotedPluginManager.html" title="InfinotedPluginManager"><span class="type">InfinotedPluginManager</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="InfinotedPluginManagerClass"></a><h3>struct InfinotedPluginManagerClass</h3>
<pre class="programlisting">struct InfinotedPluginManagerClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedPlugin"></a><h3>struct InfinotedPlugin</h3>
<pre class="programlisting">struct InfinotedPlugin {
const gchar* name;
const gchar* description;
const InfinotedParameterInfo* options;
gsize info_size;
gsize connection_info_size;
gsize session_info_size;
const gchar* session_type;
void(*on_info_initialize)(gpointer plugin_info);
gboolean(*on_initialize)(InfinotedPluginManager* manager,
gpointer plugin_info,
GError** error);
void(*on_deinitialize)(gpointer plugin_info);
void(*on_connection_added)(InfXmlConnection* connection,
gpointer plugin_info,
gpointer connection_info);
void(*on_connection_removed)(InfXmlConnection* connection,
gpointer plugin_info,
gpointer connection_info);
void(*on_session_added)(const InfBrowserIter* iter,
InfSessionProxy* proxy,
gpointer plugin_info,
gpointer session_info);
void(*on_session_removed)(const InfBrowserIter* iter,
InfSessionProxy* proxy,
gpointer plugin_info,
gpointer session_info);
};
</pre>
<p>Declares a InfinotedPlugin. If an instance of this structure is called
<code class="literal">INFINOTED_PLUGIN</code> and exported from a shared object, it
can be loaded as a plugin by infinoted.</p>
<div class="refsect3">
<a name="InfinotedPlugin.members"></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>const <span class="type">gchar</span> *<em class="structfield"><code><a name="InfinotedPlugin.name"></a>name</code></em>;</p></td>
<td class="struct_member_description"><p>The name of the plugin. The filename of the shared object should
be <code class="literal">libinfinoted-plugin-<span class="emphasis"><em><name></em></span></code>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="InfinotedPlugin.description"></a>description</code></em>;</p></td>
<td class="struct_member_description"><p>A human-readable description of what the plugin does.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterInfo" title="struct InfinotedParameterInfo"><span class="type">InfinotedParameterInfo</span></a> *<em class="structfield"><code><a name="InfinotedPlugin.options"></a>options</code></em>;</p></td>
<td class="struct_member_description"><p>A 0-terminated list of plugin parameters. The parameters are
provided to the plugin via the infinoted configuration file or the command
line. The last element of the list must have the <em class="parameter"><code>name</code></em>
field set to <code class="literal">NULL</code>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gsize</span> <em class="structfield"><code><a name="InfinotedPlugin.info-size"></a>info_size</code></em>;</p></td>
<td class="struct_member_description"><p>The size of the plugin instance structure. When the plugin
is instantiated, this amount of memory will be allocated for the plugin
instance. This field must be different from 0.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gsize</span> <em class="structfield"><code><a name="InfinotedPlugin.connection-info-size"></a>connection_info_size</code></em>;</p></td>
<td class="struct_member_description"><p>The size of the plugin's connection info structure.
For each plugin instance, this amount of memory will be allocated for each
connection of the server. The plugin can use it to store
connection-specific data. This field can be 0.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gsize</span> <em class="structfield"><code><a name="InfinotedPlugin.session-info-size"></a>session_info_size</code></em>;</p></td>
<td class="struct_member_description"><p>The size of the plugin's session info structure. For
each plugin instance, this amount of memory will be allocated for each
session that is currently active on the server. The plugin can use it to
store session-specific data. This field can be 0.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="InfinotedPlugin.session-type"></a>session_type</code></em>;</p></td>
<td class="struct_member_description"><p>If non-<code class="literal">NULL</code>, specifies the session type handled by the
plugin. Only for sessions of this type or a derived type a session info
structure is allocated. The <em class="parameter"><code>on_session_added</code></em>
and <em class="parameter"><code>on_session_removed</code></em>
callbacks are always made, independent of this field.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfinotedPlugin.on-info-initialize"></a>on_info_initialize</code></em> ()</p></td>
<td class="struct_member_description"><p>Function called after the plugin has been
instantiated. It should initialize all fields of the plugin instance
to a sane default value.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfinotedPlugin.on-initialize"></a>on_initialize</code></em> ()</p></td>
<td class="struct_member_description"><p>Function called to initialize the plugin. The function can
return <code class="literal">FALSE</code> and set the <em class="parameter"><code>error</code></em>
parameter to prevent the plugin from
being used. The server will not be started in this case. Even if this
function returns <code class="literal">FALSE</code>, <em class="parameter"><code>on_deinitialize</code></em>
will be called on the plugin to
clean up partly constructed plugin data by this function.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfinotedPlugin.on-deinitialize"></a>on_deinitialize</code></em> ()</p></td>
<td class="struct_member_description"><p>Function called when the plugin is unloaded. Should clean
up all resources the plugin has allocated.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfinotedPlugin.on-connection-added"></a>on_connection_added</code></em> ()</p></td>
<td class="struct_member_description"><p>Function called when there is a new connection to the
server. It is also called for all existing connections at the time the
plugin is loaded.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfinotedPlugin.on-connection-removed"></a>on_connection_removed</code></em> ()</p></td>
<td class="struct_member_description"><p>Function called when a client connection has been
dropped. It is also called for all existing connections right before the
plugin is unloaded.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfinotedPlugin.on-session-added"></a>on_session_added</code></em> ()</p></td>
<td class="struct_member_description"><p>Function called when a new session has become active on
the server. It is also called for all existing sessions at the time the
plugin is loaded.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfinotedPlugin.on-session-removed"></a>on_session_removed</code></em> ()</p></td>
<td class="struct_member_description"><p>Function called when a session has become inactive and
the server is freeing resources allocated to it. It is also called for all
existing sessions right before the plugin is unloaded.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedPluginManagerError"></a><h3>enum InfinotedPluginManagerError</h3>
<p>Error codes for the <code class="literal">INFINOTED_PLUGIN_MANAGER_ERROR</code>
error domain. These errors can occur when loading a plugin with
<a class="link" href="InfinotedPluginManager.html#infinoted-plugin-manager-load" title="infinoted_plugin_manager_load ()"><code class="function">infinoted_plugin_manager_load()</code></a>.</p>
<div class="refsect3">
<a name="InfinotedPluginManagerError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="INFINOTED-PLUGIN-MANAGER-ERROR-OPEN-FAILED:CAPS"></a>INFINOTED_PLUGIN_MANAGER_ERROR_OPEN_FAILED</p></td>
<td class="enum_member_description">
<p>Failed to open the code module
of a plugin.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INFINOTED-PLUGIN-MANAGER-ERROR-NO-ENTRY-POINT:CAPS"></a>INFINOTED_PLUGIN_MANAGER_ERROR_NO_ENTRY_POINT</p></td>
<td class="enum_member_description">
<p>The code module of a plugin
does not provide the <code class="literal">INFINOTED_PLUGIN</code> symbol.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfinotedPluginManager.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfinotedPluginManager--credentials"></a><h3>The <code class="literal">“credentials”</code> property</h3>
<pre class="programlisting"> “credentials” <a href="../html/InfCertificateCredentials.html#InfCertificateCredentials-struct"><span class="type">InfCertificateCredentials</span></a> *</pre>
<p>The server's TLS credentials.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedPluginManager--directory"></a><h3>The <code class="literal">“directory”</code> property</h3>
<pre class="programlisting"> “directory” <a href="../html/InfdDirectory.html#InfdDirectory-struct"><span class="type">InfdDirectory</span></a> *</pre>
<p>The infinote directory served by the server.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedPluginManager--log"></a><h3>The <code class="literal">“log”</code> property</h3>
<pre class="programlisting"> “log” <a class="link" href="InfinotedLog.html" title="InfinotedLog"><span class="type">InfinotedLog</span></a> *</pre>
<p>The log object into which to write log messages.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedPluginManager--path"></a><h3>The <code class="literal">“path”</code> property</h3>
<pre class="programlisting"> “path” <span class="type">gchar</span> *</pre>
<p>The path from which plugins are loaded.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|