/usr/share/gtk-doc/html/libinfinity-0.6/InfdSessionProxy.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfdSessionProxy: 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="ch05.html" title="Libinfinity server side API">
<link rel="prev" href="libinfinity-0.6-InfdChatFilesystemFormat.html" title="Storage of chat sessions on the file system">
<link rel="next" href="InfdRequest.html" title="InfdRequest">
<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="#InfdSessionProxy.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfdSessionProxy.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfdSessionProxy.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfdSessionProxy.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfdSessionProxy.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="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libinfinity-0.6-InfdChatFilesystemFormat.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfdRequest.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfdSessionProxy"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfdSessionProxy.top_of_page"></a>InfdSessionProxy</span></h2>
<p>InfdSessionProxy — Server-side session management</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfdSessionProxy.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="InfdSessionProxy.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">
<a class="link" href="InfdSessionProxy.html#infd-session-proxy-subscribe-to" title="infd_session_proxy_subscribe_to ()">infd_session_proxy_subscribe_to</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="InfdSessionProxy.html#infd-session-proxy-unsubscribe" title="infd_session_proxy_unsubscribe ()">infd_session_proxy_unsubscribe</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="InfdSessionProxy.html#infd-session-proxy-has-subscriptions" title="infd_session_proxy_has_subscriptions ()">infd_session_proxy_has_subscriptions</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="InfdSessionProxy.html#infd-session-proxy-is-subscribed" title="infd_session_proxy_is_subscribed ()">infd_session_proxy_is_subscribed</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="InfdSessionProxy.html#infd-session-proxy-is-idle" title="infd_session_proxy_is_idle ()">infd_session_proxy_is_idle</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.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"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="InfdSessionProxy.html#InfdSessionProxy--idle" title="The “idle” property">idle</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *</td>
<td class="property_name"><a class="link" href="InfdSessionProxy.html#InfdSessionProxy--io" title="The “io” property">io</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a> *</td>
<td class="property_name"><a class="link" href="InfdSessionProxy.html#InfdSessionProxy--subscription-group" title="The “subscription-group” property">subscription-group</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.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="InfdSessionProxy.html#InfdSessionProxy-add-subscription" title="The “add-subscription” signal">add-subscription</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
<td class="signal_name"><a class="link" href="InfdSessionProxy.html#InfdSessionProxy-reject-user-join" title="The “reject-user-join” signal">reject-user-join</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfdSessionProxy.html#InfdSessionProxy-remove-subscription" title="The “remove-subscription” signal">remove-subscription</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.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="InfdSessionProxy.html#InfdSessionProxy-struct" title="struct InfdSessionProxy">InfdSessionProxy</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfdSessionProxy.html#InfdSessionProxyClass" title="struct InfdSessionProxyClass">InfdSessionProxyClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfdSessionProxy
</pre>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfdSessionProxy implements
<a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject">InfCommunicationObject</a> and <a class="link" href="InfSessionProxy.html" title="InfSessionProxy">InfSessionProxy</a>.</p>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/server/infd-session-proxy.h>
</pre>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.description"></a><h2>Description</h2>
<p><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> is a manager for <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> that is specific for the
server side. The <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> manages exactly one <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>. It is
usually created by <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> when the content of a node is requested.</p>
<p><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> allows to perform server-specific operations for the
session it manages, such as joining a local user, or removing a connection
from the list of subscribed connections. In addition it handles requests
made by its counterpart, <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a>, for the client side, such as
remote user joins.</p>
<p><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> implements the <a class="link" href="InfSessionProxy.html" title="InfSessionProxy"><span class="type">InfSessionProxy</span></a> interface, which can be
used to access the underlying <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> or to join a local user.</p>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="infd-session-proxy-subscribe-to"></a><h3>infd_session_proxy_subscribe_to ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infd_session_proxy_subscribe_to (<em class="parameter"><code><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> *proxy</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">guint</span> seq_id</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> synchronize</code></em>);</pre>
<p>Subscribes <em class="parameter"><code>connection</code></em>
to <em class="parameter"><code>proxy</code></em>
's session. The first thing that will be
done is a synchronization (see <a class="link" href="InfSession.html#inf-session-synchronize-to" title="inf_session_synchronize_to ()"><code class="function">inf_session_synchronize_to()</code></a>). Then, all
changes to the session are propagated to <em class="parameter"><code>connection</code></em>
.</p>
<p><em class="parameter"><code>seq_id</code></em>
should be a unique number for <em class="parameter"><code>connection</code></em>
, and the same number must
be passed on the client side to the <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> object. Normally
<a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> and <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> take care of choosing an appropriate
sequence identifier.</p>
<p>Normally, you want to set <em class="parameter"><code>synchronize</code></em>
to <code class="literal">TRUE</code> in which case the whole
session state will be synchronized to <em class="parameter"><code>connection</code></em>
(within the subscription
group). However, if for whatever reason the remote site already has a
copy of the session, then you may set <em class="parameter"><code>synchronize</code></em>
to <code class="literal">FALSE</code> to skip
synchronization. This happens for example for newly created documents, or
when the remote site synchronized the local site and wants to be
initially subscribed.</p>
<p>If <em class="parameter"><code>proxy</code></em>
's session is not in <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a> status, but in
<a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>, then <em class="parameter"><code>connection</code></em>
must be the connection that
synchronizes the session and <em class="parameter"><code>synchronize</code></em>
needs to be set to <code class="literal">FALSE</code>. This
causes the synchronizing connection to initially be subscribed. This
needs to be called directly after having created the session proxy (i.e.
without returning to the main loop before) so that the synchronization
connection is added to the subscription group for synchronization.</p>
<p>Otherwise a subscription can only be initiated if <em class="parameter"><code>proxy</code></em>
's session is in
state <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>.</p>
<div class="refsect3">
<a name="id-1.6.9.12.2.9"></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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> that is not yet subscribed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>seq_id</p></td>
<td class="parameter_description"><p>The sequence identifier for <em class="parameter"><code>connection</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>synchronize</p></td>
<td class="parameter_description"><p>If <code class="literal">TRUE</code>, then synchronize the session to <em class="parameter"><code>connection</code></em>
first.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infd-session-proxy-unsubscribe"></a><h3>infd_session_proxy_unsubscribe ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infd_session_proxy_unsubscribe (<em class="parameter"><code><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> *proxy</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Unsubscribes a subscribed connection from <em class="parameter"><code>proxy</code></em>
's session. This will
prevent all users joined via <em class="parameter"><code>connection</code></em>
to continue modifying the
session's buffer, and it will cancel ongoing synchronization to
<em class="parameter"><code>connection</code></em>
, if not yet finished.</p>
<div class="refsect3">
<a name="id-1.6.9.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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</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 <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> to unsubscribe.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infd-session-proxy-has-subscriptions"></a><h3>infd_session_proxy_has_subscriptions ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infd_session_proxy_has_subscriptions (<em class="parameter"><code><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> *proxy</code></em>);</pre>
<p>Returns whether there are subscribed connections to the session.</p>
<div class="refsect3">
<a name="id-1.6.9.12.4.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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.9.12.4.6"></a><h4>Returns</h4>
<p> Whether there are subscribed connections.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infd-session-proxy-is-subscribed"></a><h3>infd_session_proxy_is_subscribed ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infd_session_proxy_is_subscribed (<em class="parameter"><code><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> *proxy</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Returns <code class="literal">TRUE</code> when <em class="parameter"><code>connection</code></em>
is subscribed to the session and <code class="literal">FALSE</code>
otherwise.</p>
<div class="refsect3">
<a name="id-1.6.9.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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</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 connection to check for being subscribed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.9.12.5.6"></a><h4>Returns</h4>
<p> Whether <em class="parameter"><code>connection</code></em>
is subscribed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infd-session-proxy-is-idle"></a><h3>infd_session_proxy_is_idle ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infd_session_proxy_is_idle (<em class="parameter"><code><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> *proxy</code></em>);</pre>
<p>Returns whether the session is idle. The session is considered idle when
there are no subscriptions and no synchronizations (in either direction).</p>
<div class="refsect3">
<a name="id-1.6.9.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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.6.9.12.6.6"></a><h4>Returns</h4>
<p> Whether the session is idle.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfdSessionProxy-struct"></a><h3>struct InfdSessionProxy</h3>
<pre class="programlisting">struct InfdSessionProxy;</pre>
<p><a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</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="InfdSessionProxyClass"></a><h3>struct InfdSessionProxyClass</h3>
<pre class="programlisting">struct InfdSessionProxyClass {
/* Signals */
void (*add_subscription)(InfdSessionProxy* proxy,
InfXmlConnection* connection,
guint seq_id);
void (*remove_subscription)(InfdSessionProxy* proxy,
InfXmlConnection* connection);
gboolean (*reject_user_join)(InfdSessionProxy* proxy,
InfXmlConnection* connection,
const GArray* user_properties,
InfUser* rejoin_user);
};
</pre>
<p>This structure contains the default signal handlers of the
<a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> class.</p>
<div class="refsect3">
<a name="id-1.6.9.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="InfdSessionProxyClass.add-subscription"></a>add_subscription</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfdSessionProxy.html#InfdSessionProxy-add-subscription" title="The “add-subscription” signal"><span class="type">“add-subscription”</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="InfdSessionProxyClass.remove-subscription"></a>remove_subscription</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfdSessionProxy.html#InfdSessionProxy-remove-subscription" title="The “remove-subscription” signal"><span class="type">“remove-subscription”</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="InfdSessionProxyClass.reject-user-join"></a>reject_user_join</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfdSessionProxy.html#InfdSessionProxy-reject-user-join" title="The “reject-user-join” signal"><span class="type">“reject-user-join”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfdSessionProxy--idle"></a><h3>The <code class="literal">“idle”</code> property</h3>
<pre class="programlisting"> “idle” <span class="type">gboolean</span></pre>
<p>The session is considered idle when are no subscriptions and no synchronizations.</p>
<p>Flags: Read</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdSessionProxy--io"></a><h3>The <code class="literal">“io”</code> property</h3>
<pre class="programlisting"> “io” <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *</pre>
<p>The InfIo object for scheduling events.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdSessionProxy--subscription-group"></a><h3>The <code class="literal">“subscription-group”</code> property</h3>
<pre class="programlisting"> “subscription-group” <a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a> *</pre>
<p>The communication manager group of subscribed connections.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfdSessionProxy-add-subscription"></a><h3>The <code class="literal">“add-subscription”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> *proxy,
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
<span class="type">guint</span> seq_id,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted every time a connection is subscribed to the session.</p>
<div class="refsect3">
<a name="id-1.6.9.15.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>proxy</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> emitting the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The subscribed <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>seq_id</p></td>
<td class="parameter_description"><p>The sequence identifier for <em class="parameter"><code>connection</code></em>
as passed to
<a class="link" href="InfdSessionProxy.html#infd-session-proxy-subscribe-to" title="infd_session_proxy_subscribe_to ()"><code class="function">infd_session_proxy_subscribe_to()</code></a>.</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: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdSessionProxy-reject-user-join"></a><h3>The <code class="literal">“reject-user-join”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
user_function (<a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> *proxy,
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
<span class="type">gpointer</span> user_properties,
<a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *rejoin_user,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted before every remote user join. The signal handler
can return <code class="literal">TRUE</code> in which case the <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> does not allow the
user join with <a class="link" href="libinfinity-0.6-InfError.html#INF-REQUEST-ERROR-NOT-AUTHORIZED:CAPS"><code class="literal">INF_REQUEST_ERROR_NOT_AUTHORIZED</code></a> error. If there is more
than one signal handler, then if one of them returns <code class="literal">TRUE</code> the user
join is rejected.</p>
<p>The <em class="parameter"><code>user_properties</code></em>
parameter is a <span class="type">GArray</span> of <span class="type">GParameter</span> values. It
contains the construct properties for the <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> object that would be
created if the user join is not rejected. It must not be modified, but
it can be used to make the decision whether to reject the user join or
not dependent on the parameters, such as allowing the user join only if
the user has a predefined name. The function
<a class="link" href="InfSession.html#inf-session-lookup-user-property" title="inf_session_lookup_user_property ()"><code class="function">inf_session_lookup_user_property()</code></a> can be used to look up a named
parameter in the array.</p>
<div class="refsect3">
<a name="id-1.6.9.15.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>proxy</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> emitting the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A subscribed <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> requesting the user join.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_properties</p></td>
<td class="parameter_description"><p>An array with the properties for the new user.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rejoin_user</p></td>
<td class="parameter_description"><p>The existing unavailable user that is being rejoined, or
<code class="literal">NULL</code>.</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: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="InfdSessionProxy-remove-subscription"></a><h3>The <code class="literal">“remove-subscription”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> *proxy,
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted every time a connection is unsubscribed to the session, or a
subscription is removed because the session is closed.</p>
<div class="refsect3">
<a name="id-1.6.9.15.4.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>proxy</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> emitting the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The unsubscribed <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>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
<div class="refsect1">
<a name="InfdSessionProxy.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|