/usr/share/gtk-doc/html/libinfinity-0.6/InfAdoptedSession.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfAdoptedSession: 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="ch03.html" title="Libinfinity's adOPTed implementation">
<link rel="prev" href="ch03.html" title="Libinfinity's adOPTed implementation">
<link rel="next" href="InfAdoptedSessionRecord.html" title="InfAdoptedSessionRecord">
<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="#InfAdoptedSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfAdoptedSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfAdoptedSession.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfAdoptedSession.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfAdoptedSession.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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfAdoptedSessionRecord.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfAdoptedSession"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfAdoptedSession.top_of_page"></a>InfAdoptedSession</span></h2>
<p>InfAdoptedSession — Session handling concurrency control via the adOPTed
algorithm.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfAdoptedSession.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="InfAdoptedSession.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="InfIo.html" title="InfIo"><span class="returnvalue">InfIo</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedSession.html#inf-adopted-session-get-io" title="inf_adopted_session_get_io ()">inf_adopted_session_get_io</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="returnvalue">InfAdoptedAlgorithm</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedSession.html#inf-adopted-session-get-algorithm" title="inf_adopted_session_get_algorithm ()">inf_adopted_session_get_algorithm</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="InfAdoptedSession.html#inf-adopted-session-broadcast-request" title="inf_adopted_session_broadcast_request ()">inf_adopted_session_broadcast_request</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="InfAdoptedSession.html#inf-adopted-session-undo" title="inf_adopted_session_undo ()">inf_adopted_session_undo</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="InfAdoptedSession.html#inf-adopted-session-redo" title="inf_adopted_session_redo ()">inf_adopted_session_redo</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="InfAdoptedSession.html#inf-adopted-session-read-request-info" title="inf_adopted_session_read_request_info ()">inf_adopted_session_read_request_info</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="InfAdoptedSession.html#inf-adopted-session-write-request-info" title="inf_adopted_session_write_request_info ()">inf_adopted_session_write_request_info</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.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 class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> *</td>
<td class="property_name"><a class="link" href="InfAdoptedSession.html#InfAdoptedSession--algorithm" title="The “algorithm” property">algorithm</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="InfAdoptedSession.html#InfAdoptedSession--io" title="The “io” property">io</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="InfAdoptedSession.html#InfAdoptedSession--max-total-log-size" title="The “max-total-log-size” property">max-total-log-size</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.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">gboolean</span></td>
<td class="signal_name"><a class="link" href="InfAdoptedSession.html#InfAdoptedSession-check-request" title="The “check-request” signal">check-request</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.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">enum</td>
<td class="function_name"><a class="link" href="InfAdoptedSession.html#InfAdoptedSessionError" title="enum InfAdoptedSessionError">InfAdoptedSessionError</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfAdoptedSession.html#InfAdoptedSession-struct" title="struct InfAdoptedSession">InfAdoptedSession</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfAdoptedSession.html#InfAdoptedSessionClass" title="struct InfAdoptedSessionClass">InfAdoptedSessionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="InfSession.html" title="InfSession">InfSession</a>
<span class="lineart">╰──</span> InfAdoptedSession
</pre>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfAdoptedSession implements
<a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject">InfCommunicationObject</a>.</p>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/adopted/inf-adopted-session.h>
</pre>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.description"></a><h2>Description</h2>
<p><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> handles concurrency control with an <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a>
on top of a <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>. It takes care of sending all necessary information
to joining users, receives requests from the network (passing them to
<a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a>) and transfers local requests to the other users. It
also makes sure to periodically send the state the local host is in to
other uses even if the local users are idle (which is required for others
to cleanup their request logs and request caches).</p>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-adopted-session-get-io"></a><h3>inf_adopted_session_get_io ()</h3>
<pre class="programlisting"><a class="link" href="InfIo.html" title="InfIo"><span class="returnvalue">InfIo</span></a> *
inf_adopted_session_get_io (<em class="parameter"><code><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> *session</code></em>);</pre>
<p>Returns the <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object of <em class="parameter"><code>session</code></em>
.</p>
<div class="refsect3">
<a name="inf-adopted-session-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>session</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-adopted-session-get-io.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-session-get-algorithm"></a><h3>inf_adopted_session_get_algorithm ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="returnvalue">InfAdoptedAlgorithm</span></a> *
inf_adopted_session_get_algorithm (<em class="parameter"><code><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> *session</code></em>);</pre>
<p>Returns the <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> object of <em class="parameter"><code>session</code></em>
. Returns <code class="literal">NULL</code> if
<em class="parameter"><code>session</code></em>
has status <a class="link" href="InfSession.html#INF-SESSION-PRESYNC:CAPS"><code class="literal">INF_SESSION_PRESYNC</code></a> or <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>
because there the algorithm object is not yet created before successful
synchronization.</p>
<div class="refsect3">
<a name="inf-adopted-session-get-algorithm.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>session</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-adopted-session-get-algorithm.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a>, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-session-broadcast-request"></a><h3>inf_adopted_session_broadcast_request ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_session_broadcast_request (<em class="parameter"><code><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *request</code></em>);</pre>
<p>Sends a request to all subscribed connections. The request should originate
from a call to <code class="function">inf_adopted_algorithm_generate_request_noexec()</code>,
<a class="link" href="InfAdoptedAlgorithm.html#inf-adopted-algorithm-generate-request" title="inf_adopted_algorithm_generate_request ()"><code class="function">inf_adopted_algorithm_generate_request()</code></a>,
<code class="function">inf_adopted_algorithm_generate_undo()</code> or
<code class="function">inf_adopted_algorithm_generate_redo()</code> with <em class="parameter"><code>session</code></em>
's <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a>.</p>
<div class="refsect3">
<a name="inf-adopted-session-broadcast-request.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>session</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>request</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> obtained from <em class="parameter"><code>session</code></em>
's algorithm.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-session-undo"></a><h3>inf_adopted_session_undo ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_session_undo (<em class="parameter"><code><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *user</code></em>,
<em class="parameter"><code><span class="type">guint</span> n</code></em>);</pre>
<p>This is a shortcut for creating <em class="parameter"><code>n</code></em>
undo requests and broadcasting them.
If <em class="parameter"><code>n</code></em>
> 1 then this is also more efficient.</p>
<div class="refsect3">
<a name="inf-adopted-session-undo.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>session</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user</p></td>
<td class="parameter_description"><p>A local <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>The number of undo requests to issue.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-session-redo"></a><h3>inf_adopted_session_redo ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_session_redo (<em class="parameter"><code><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *user</code></em>,
<em class="parameter"><code><span class="type">guint</span> n</code></em>);</pre>
<p>This is a shortcut for creating <em class="parameter"><code>n</code></em>
redo requests and broadcasting them.
If <em class="parameter"><code>n</code></em>
> 1 then this is also more efficient.</p>
<div class="refsect3">
<a name="inf-adopted-session-redo.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>session</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user</p></td>
<td class="parameter_description"><p>A local <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>The number of redo requests to issue.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-session-read-request-info"></a><h3>inf_adopted_session_read_request_info ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_adopted_session_read_request_info (<em class="parameter"><code><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> *session</code></em>,
<em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="type">InfAdoptedStateVector</span></a> *diff_vec</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> **user</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="type">InfAdoptedStateVector</span></a> **time</code></em>,
<em class="parameter"><code><span class="type">xmlNodePtr</span> *operation</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This function reads common information such as the state vector the request
was made and the user that made the request from XML. It is most likely to
be used by implementations of the xml_to_request virtual function.</p>
<div class="refsect3">
<a name="inf-adopted-session-read-request-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>session</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The XML to read the data from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>diff_vec</p></td>
<td class="parameter_description"><p>The reference vector of the time vector of the request, or
<code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user</p></td>
<td class="parameter_description"><p>Location to store the user of the request, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>time</p></td>
<td class="parameter_description"><p>Location to store the state the request was made, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>operation</p></td>
<td class="parameter_description"><p>Location to store the operation of the request, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to place an error, if any.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-adopted-session-read-request-info.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the data could be read successfully, <code class="literal">FALSE</code> if the XML
request does not contain valid request data, in which case <em class="parameter"><code>error</code></em>
is set.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-session-write-request-info"></a><h3>inf_adopted_session_write_request_info ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_session_write_request_info
(<em class="parameter"><code><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *request</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="type">InfAdoptedStateVector</span></a> *diff_vec</code></em>,
<em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>,
<em class="parameter"><code><span class="type">xmlNodePtr</span> operation</code></em>);</pre>
<p>This function writes common data from <em class="parameter"><code>request</code></em>
, such as the user that
issued the request and the state in which the request was made into <em class="parameter"><code>xml</code></em>
.
If <em class="parameter"><code>diff_vec</code></em>
is given, then the state is written as a diff to this vector,
see <a class="link" href="InfAdoptedStateVector.html#inf-adopted-state-vector-to-string-diff" title="inf_adopted_state_vector_to_string_diff ()"><code class="function">inf_adopted_state_vector_to_string_diff()</code></a>. Deserializing this data
again (via <a class="link" href="InfAdoptedSession.html#inf-adopted-session-read-request-info" title="inf_adopted_session_read_request_info ()"><code class="function">inf_adopted_session_read_request_info()</code></a>) requires the same
<em class="parameter"><code>diff_vec</code></em>
then.</p>
<p>This function is most likely to be used by implementations of the
request_to_xml virtual function.</p>
<div class="refsect3">
<a name="inf-adopted-session-write-request-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>session</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>request</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> whose info to write.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>diff_vec</p></td>
<td class="parameter_description"><p>A reference state vector, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The XML node to write the data into.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>operation</p></td>
<td class="parameter_description"><p>An XML node representing the operation of the request, or
<code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfAdoptedSessionError"></a><h3>enum InfAdoptedSessionError</h3>
<p>Error codes for <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>. These only occur when invalid requests
are received from the network.</p>
<div class="refsect3">
<a name="InfAdoptedSessionError.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="INF-ADOPTED-SESSION-ERROR-NO-SUCH-USER:CAPS"></a>INF_ADOPTED_SESSION_ERROR_NO_SUCH_USER</p></td>
<td class="enum_member_description">
<p>The "user" field in a request
message does not contain a valid user ID.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-ADOPTED-SESSION-ERROR-MISSING-OPERATION:CAPS"></a>INF_ADOPTED_SESSION_ERROR_MISSING_OPERATION</p></td>
<td class="enum_member_description">
<p>A request message does not
contain an operation.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-ADOPTED-SESSION-ERROR-INVALID-REQUEST:CAPS"></a>INF_ADOPTED_SESSION_ERROR_INVALID_REQUEST</p></td>
<td class="enum_member_description">
<p>A request in a synchronized
request log is invalid. Invalid means that it is not the request that
was issued after the previous request in the log, or that it is an Undo
or Redo request without a request to Undo or Redo, respectively.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-ADOPTED-SESSION-ERROR-MISSING-STATE-VECTOR:CAPS"></a>INF_ADOPTED_SESSION_ERROR_MISSING_STATE_VECTOR</p></td>
<td class="enum_member_description">
<p>A synchronized user does
not contain that the state that user currently is in.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-ADOPTED-SESSION-ERROR-FAILED:CAPS"></a>INF_ADOPTED_SESSION_ERROR_FAILED</p></td>
<td class="enum_member_description">
<p>No further specified error code.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedSession-struct"></a><h3>struct InfAdoptedSession</h3>
<pre class="programlisting">struct InfAdoptedSession;</pre>
<p><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</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="InfAdoptedSessionClass"></a><h3>struct InfAdoptedSessionClass</h3>
<pre class="programlisting">struct InfAdoptedSessionClass {
InfAdoptedRequest*(*xml_to_request)(InfAdoptedSession* session,
xmlNodePtr xml,
InfAdoptedStateVector* diff_vec,
gboolean for_sync,
GError** error);
void(*request_to_xml)(InfAdoptedSession* session,
xmlNodePtr xml,
InfAdoptedRequest* request,
InfAdoptedStateVector* diff_vec,
gboolean for_sync);
/* Signals */
gboolean(*check_request)(InfAdoptedSession* session,
InfAdoptedRequest* request,
InfAdoptedUser* user);
};
</pre>
<p>Virtual functions and default signal handlers for <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>.</p>
<div class="refsect3">
<a name="InfAdoptedSessionClass.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><em class="structfield"><code><a name="InfAdoptedSessionClass.xml-to-request"></a>xml_to_request</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to deserialize an <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a>
from XML. The implementation of this function can use
<a class="link" href="InfAdoptedSession.html#inf-adopted-session-read-request-info" title="inf_adopted_session_read_request_info ()"><code class="function">inf_adopted_session_read_request_info()</code></a> to read the common info.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfAdoptedSessionClass.request-to-xml"></a>request_to_xml</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to serialize an <a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a>
to XML. This function should add properties and children to the given XML
node. At might use <a class="link" href="InfAdoptedSession.html#inf-adopted-session-write-request-info" title="inf_adopted_session_write_request_info ()"><code class="function">inf_adopted_session_write_request_info()</code></a> to write the
common info.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfAdoptedSessionClass.check-request"></a>check_request</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler of the
InfAdoptedSession::check-request signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfAdoptedSession--algorithm"></a><h3>The <code class="literal">“algorithm”</code> property</h3>
<pre class="programlisting"> “algorithm” <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> *</pre>
<p>The adOPTed algorithm used for translating incoming requests.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedSession--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 IO object used for timeouts.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedSession--max-total-log-size"></a><h3>The <code class="literal">“max-total-log-size”</code> property</h3>
<pre class="programlisting"> “max-total-log-size” <span class="type">guint</span></pre>
<p>The maximum number of requests to keep in all user's logs.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: 2048</p>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedSession.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfAdoptedSession-check-request"></a><h3>The <code class="literal">“check-request”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
user_function (<a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> *session,
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *request,
<a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *user,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted whenever the session received a request from a
non-local user. It is used to decide whether the request should be
processed or not. Note that generally not processing a request results is
loss of synchronization, since other hosts might process the request.
Only if the same condition can be applied on all sites a request should
be rejected. Another possibility is to reject a request at a central host
before it gets distributed to all other clients. If there is one signal
handler returning <code class="literal">TRUE</code> the request is rejected, i.e. only if all signal
handlers return <code class="literal">FALSE</code> it is accepted.</p>
<div class="refsect3">
<a name="InfAdoptedSession-check-request.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>session</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a> which is about to process a request.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>request</p></td>
<td class="parameter_description"><p>The request to be processed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user</p></td>
<td class="parameter_description"><p>The user who issued the request.</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="InfAdoptedSession.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>, <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|