This file is indexed.

/usr/share/gtk-doc/html/libinfinity-0.6/InfSession.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
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfSession: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfRequestResult.html" title="Result of an asynchronous request">
<link rel="next" href="InfChatSession.html" title="InfChatSession">
<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="#InfSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#InfSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#InfSession.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#InfSession.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#InfSession.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfRequestResult.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfChatSession.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfSession"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfSession.top_of_page"></a>InfSession</span></h2>
<p>InfSession — Basic session object and synchronization</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfSession.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="InfSession.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">const <span class="returnvalue">GParameter</span> *
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-lookup-user-property" title="inf_session_lookup_user_property ()">inf_session_lookup_user_property</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GParameter</span> *
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-get-user-property" title="inf_session_get_user_property ()">inf_session_get_user_property</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="InfSession.html#inf-session-user-to-xml" title="inf_session_user_to_xml ()">inf_session_user_to_xml</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="InfSession.html#inf-session-close" title="inf_session_close ()">inf_session_close</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-get-communication-manager" title="inf_session_get_communication_manager ()">inf_session_get_communication_manager</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfBuffer.html" title="InfBuffer"><span class="returnvalue">InfBuffer</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-get-buffer" title="inf_session_get_buffer ()">inf_session_get_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfUserTable.html" title="InfUserTable"><span class="returnvalue">InfUserTable</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-get-user-table" title="inf_session_get_user_table ()">inf_session_get_user_table</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfSession.html#InfSessionStatus" title="enum InfSessionStatus"><span class="returnvalue">InfSessionStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-get-status" title="inf_session_get_status ()">inf_session_get_status</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfUser.html" title="InfUser"><span class="returnvalue">InfUser</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-add-user" title="inf_session_add_user ()">inf_session_add_user</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="InfSession.html#inf-session-set-user-status" title="inf_session_set_user_status ()">inf_session_set_user_status</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="InfSession.html#inf-session-synchronize-from" title="inf_session_synchronize_from ()">inf_session_synchronize_from</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="InfSession.html#inf-session-synchronize-to" title="inf_session_synchronize_to ()">inf_session_synchronize_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="InfSession.html#inf-session-cancel-synchronization" title="inf_session_cancel_synchronization ()">inf_session_cancel_synchronization</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfSession.html#InfSessionSyncStatus" title="enum InfSessionSyncStatus"><span class="returnvalue">InfSessionSyncStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-get-synchronization-status" title="inf_session_get_synchronization_status ()">inf_session_get_synchronization_status</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-get-synchronization-progress" title="inf_session_get_synchronization_progress ()">inf_session_get_synchronization_progress</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="InfSession.html#inf-session-has-synchronizations" title="inf_session_has_synchronizations ()">inf_session_has_synchronizations</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="returnvalue">InfCommunicationGroup</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfSession.html#inf-session-get-subscription-group" title="inf_session_get_subscription_group ()">inf_session_get_subscription_group</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="InfSession.html#inf-session-set-subscription-group" title="inf_session_set_subscription_group ()">inf_session_set_subscription_group</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="InfSession.html#inf-session-send-to-subscriptions" title="inf_session_send_to_subscriptions ()">inf_session_send_to_subscriptions</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfSession.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="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a> *</td>
<td class="property_name"><a class="link" href="InfSession.html#InfSession--buffer" title="The “buffer” property">buffer</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *</td>
<td class="property_name"><a class="link" href="InfSession.html#InfSession--communication-manager" title="The “communication-manager” property">communication-manager</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="InfSession.html#InfSessionStatus" title="enum InfSessionStatus"><span class="type">InfSessionStatus</span></a></td>
<td class="property_name"><a class="link" href="InfSession.html#InfSession--status" title="The “status” property">status</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *</td>
<td class="property_name"><a class="link" href="InfSession.html#InfSession--subscription-group" title="The “subscription-group” property">subscription-group</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *</td>
<td class="property_name"><a class="link" href="InfSession.html#InfSession--sync-connection" title="The “sync-connection” property">sync-connection</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *</td>
<td class="property_name"><a class="link" href="InfSession.html#InfSession--sync-group" title="The “sync-group” property">sync-group</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *</td>
<td class="property_name"><a class="link" href="InfSession.html#InfSession--user-table" title="The “user-table” property">user-table</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfSession.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="InfSession.html#InfSession-close" title="The “close” signal">close</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="InfSession.html#InfSession-error" title="The “error” signal">error</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="InfSession.html#InfSession-synchronization-begin" title="The “synchronization-begin” signal">synchronization-begin</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="InfSession.html#InfSession-synchronization-complete" title="The “synchronization-complete” signal">synchronization-complete</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="InfSession.html#InfSession-synchronization-failed" title="The “synchronization-failed” signal">synchronization-failed</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="InfSession.html#InfSession-synchronization-progress" title="The “synchronization-progress” signal">synchronization-progress</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfSession.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="InfSession.html#InfSessionStatus" title="enum InfSessionStatus">InfSessionStatus</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfSession.html#InfSessionSyncStatus" title="enum InfSessionSyncStatus">InfSessionSyncStatus</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfSession.html#InfSessionSyncError" title="enum InfSessionSyncError">InfSessionSyncError</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfSession.html#InfSession-struct" title="struct InfSession">InfSession</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfSession.html#InfSessionClass" title="struct InfSessionClass">InfSessionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
    <span class="lineart">╰──</span> InfSessionStatus
    GObject
    <span class="lineart">╰──</span> InfSession
        <span class="lineart">├──</span> <a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession">InfAdoptedSession</a>
        <span class="lineart">╰──</span> <a class="link" href="InfChatSession.html" title="InfChatSession">InfChatSession</a>
</pre>
</div>
<div class="refsect1">
<a name="InfSession.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfSession implements
 <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject">InfCommunicationObject</a>.</p>
</div>
<div class="refsect1">
<a name="InfSession.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libinfinity/common/inf-session.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="InfSession.description"></a><h2>Description</h2>
<p><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> represents an editing session. The actual type of document that
is edited is not specified, so instantiating <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> does not make
any sense. You rather want to use a derived class such as <span class="type">InfTextSession</span>.
Normally, the <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> or <a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a>, respectively, already take
care of instantiating the correct <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p>
<p>A session basically consists of the document being edited (also called
buffer, see <a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a>) and the users that are working on the document,
see <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a>.</p>
<p>A session can either start in <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a> state, in which it
is created with the initial buffer and user table. It may also start in
<a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a> state. In this case, both buffer and user table
are initially empty and are copied from another system over the network.
When the copy is complete, the session enters <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a> state.</p>
<p>To be notified about changes other users make to a session, you need to
subscribe to the session (on client side), or wait for incoming
subscriptions (on server side). This is normally done by
<code class="function">infc_browser_iter_subscribe_session()</code>. The first action that is performed
upon subscription is a synchronization as described above. When the
synchronization is complete, the <a class="link" href="InfSession.html#InfSession-synchronization-complete" title="The “synchronization-complete” signal"><span class="type">“synchronization-complete”</span></a> signal
is emitted.</p>
<p>After subscription, one can observe modifications other users make, but it is
not possible to make own modifications. Before doing so, a <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> needs to
be joined. This is done by client/server specific API from
<a class="link" href="InfSessionProxy.html" title="InfSessionProxy"><span class="type">InfSessionProxy</span></a>, in particular <a class="link" href="InfSessionProxy.html#inf-session-proxy-join-user" title="inf_session_proxy_join_user ()"><code class="function">inf_session_proxy_join_user()</code></a>. The
required parameters still depend on the actual note type, which is why most
note implementations offer their own API to join a user.</p>
</div>
<div class="refsect1">
<a name="InfSession.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-session-lookup-user-property"></a><h3>inf_session_lookup_user_property ()</h3>
<pre class="programlisting">const <span class="returnvalue">GParameter</span> *
inf_session_lookup_user_property (<em class="parameter"><code>const <span class="type">GParameter</span> *params</code></em>,
                                  <em class="parameter"><code><span class="type">guint</span> n_params</code></em>,
                                  <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Looks up the parameter with the given name in <em class="parameter"><code>array</code></em>
.</p>
<div class="refsect3">
<a name="inf-session-lookup-user-property.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>params</p></td>
<td class="parameter_description"><p>A pointer to an array of containing <span class="type">GParameter</span> values.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_params</p></td>
<td class="parameter_description"><p>The number of elements in the aforementioned array</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>Name to look up.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-lookup-user-property.returns"></a><h4>Returns</h4>
<p> A <span class="type">GParameter</span>, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-get-user-property"></a><h3>inf_session_get_user_property ()</h3>
<pre class="programlisting"><span class="returnvalue">GParameter</span> *
inf_session_get_user_property (<em class="parameter"><code><span class="type">GArray</span> *array</code></em>,
                               <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>Looks up the paremeter with the given name in <em class="parameter"><code>array</code></em>
. If there is no such
parameter, a new one will be created.</p>
<div class="refsect3">
<a name="inf-session-get-user-property.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>array</p></td>
<td class="parameter_description"><p>A <span class="type">GArray</span> containing <span class="type">GParameter</span> values.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>Name to look up.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-get-user-property.returns"></a><h4>Returns</h4>
<p> A <span class="type">GParameter</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-user-to-xml"></a><h3>inf_session_user_to_xml ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_session_user_to_xml (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>,
                         <em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>,
                         <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>This is a convenience function that queries <em class="parameter"><code>user</code></em>
's properties and
calls set_xml_user_props with them. This adds the properties of <em class="parameter"><code>user</code></em>

to <em class="parameter"><code>xml</code></em>
.</p>
<p>An equivalent user object may be built by calling the get_xml_user_props
vfunc on <em class="parameter"><code>xml</code></em>
 and then calling the user_new vfunc with the resulting
properties.</p>
<div class="refsect3">
<a name="inf-session-user-to-xml.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="InfSession.html" title="InfSession"><span class="type">InfSession</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 <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> contained in <em class="parameter"><code>session</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>An XML node to which to add user information.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-close"></a><h3>inf_session_close ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_session_close (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>);</pre>
<p>Closes a running session. When a session is closed, it unrefs all
connections and no longer handles requests.</p>
<div class="refsect3">
<a name="inf-session-close.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-get-communication-manager"></a><h3>inf_session_get_communication_manager ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> *
inf_session_get_communication_manager (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>);</pre>
<p>Returns the communication manager for <em class="parameter"><code>session</code></em>
.</p>
<div class="refsect3">
<a name="inf-session-get-communication-manager.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-get-communication-manager.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-get-buffer"></a><h3>inf_session_get_buffer ()</h3>
<pre class="programlisting"><a class="link" href="InfBuffer.html" title="InfBuffer"><span class="returnvalue">InfBuffer</span></a> *
inf_session_get_buffer (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>);</pre>
<p>Returns the buffer used by <em class="parameter"><code>session</code></em>
.</p>
<div class="refsect3">
<a name="inf-session-get-buffer.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-get-buffer.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-get-user-table"></a><h3>inf_session_get_user_table ()</h3>
<pre class="programlisting"><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="returnvalue">InfUserTable</span></a> *
inf_session_get_user_table (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>);</pre>
<p>Returns the user table used by <em class="parameter"><code>session</code></em>
.</p>
<div class="refsect3">
<a name="inf-session-get-user-table.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-get-user-table.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-get-status"></a><h3>inf_session_get_status ()</h3>
<pre class="programlisting"><a class="link" href="InfSession.html#InfSessionStatus" title="enum InfSessionStatus"><span class="returnvalue">InfSessionStatus</span></a>
inf_session_get_status (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>);</pre>
<p>Returns the session's status.</p>
<div class="refsect3">
<a name="inf-session-get-status.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-get-status.returns"></a><h4>Returns</h4>
<p> The status of <em class="parameter"><code>session</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-add-user"></a><h3>inf_session_add_user ()</h3>
<pre class="programlisting"><a class="link" href="InfUser.html" title="InfUser"><span class="returnvalue">InfUser</span></a> *
inf_session_add_user (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>,
                      <em class="parameter"><code>const <span class="type">GParameter</span> *params</code></em>,
                      <em class="parameter"><code><span class="type">guint</span> n_params</code></em>);</pre>
<p>Adds a user to <em class="parameter"><code>session</code></em>
. The user object is constructed via the
user_new vfunc of <a class="link" href="InfSession.html#InfSessionClass" title="struct InfSessionClass"><span class="type">InfSessionClass</span></a>. This will create a new <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>
object by default, but may be overridden by subclasses to create
different kinds of users.</p>
<p>Note that this function does not tell the other participants that the
user was added. To avoid conflicts, normally only the publisher of the
session can add users and notifies others accordingly. This is handled
by <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a> or <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a>, respectively.</p>
<p>You should not call this function unless you know what you are doing.
If <em class="parameter"><code>params</code></em>
 comes from an untrusted source, they should be checked first
with the validate_user_props virtual function.</p>
<div class="refsect3">
<a name="inf-session-add-user.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>params</p></td>
<td class="parameter_description"><p>Construction parameters for the <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> (or derived) object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_params</p></td>
<td class="parameter_description"><p>Number of parameters.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-add-user.returns"></a><h4>Returns</h4>
<p> The new <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-set-user-status"></a><h3>inf_session_set_user_status ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_session_set_user_status (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>,
                             <em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>,
                             <em class="parameter"><code><a class="link" href="InfUser.html#InfUserStatus" title="enum InfUserStatus"><span class="type">InfUserStatus</span></a> status</code></em>);</pre>
<p>Changes the status of the given <em class="parameter"><code>user</code></em>
 which needs to have the
<a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag set for this function to be called. If the status
is changed to <a class="link" href="InfUser.html#INF-USER-UNAVAILABLE:CAPS"><code class="literal">INF_USER_UNAVAILABLE</code></a>, then the user leaves the session. To
rejoin use <code class="function">infc_session_proxy_join_user()</code> or <code class="function">infd_session_proxy_add_user()</code>,
respectively for a proxy proxying <em class="parameter"><code>session</code></em>
.</p>
<div class="refsect3">
<a name="inf-session-set-user-status.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="InfSession.html" title="InfSession"><span class="type">InfSession</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="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> from <em class="parameter"><code>session</code></em>
's user table.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>status</p></td>
<td class="parameter_description"><p>New status for <em class="parameter"><code>user</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-synchronize-from"></a><h3>inf_session_synchronize_from ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_session_synchronize_from (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>);</pre>
<p>Switches <em class="parameter"><code>session</code></em>
's status to <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>. In
<a class="link" href="InfSession.html#INF-SESSION-PRESYNC:CAPS"><code class="literal">INF_SESSION_PRESYNC</code></a>, all messages from incoming the synchronizing
connection are ignored, and no cancellation request is sent to the remote
site if the status changes to <a class="link" href="InfSession.html#INF-SESSION-CLOSED:CAPS"><code class="literal">INF_SESSION_CLOSED</code></a>. The rationale behind
that status is that one can prepare a session for synchronization but start
the actual synchronization later, after having made sure that the remote
site is ready to perform the synchronization.</p>
<div class="refsect3">
<a name="inf-session-synchronize-from.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> in status <a class="link" href="InfSession.html#INF-SESSION-PRESYNC:CAPS"><code class="literal">INF_SESSION_PRESYNC</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-synchronize-to"></a><h3>inf_session_synchronize_to ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_session_synchronize_to (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>,
                            <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</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>Initiates a synchronization to <em class="parameter"><code>connection</code></em>
. On the other end of
<em class="parameter"><code>connection</code></em>
, a new session with the sync-connection and sync-group
construction properties set should have been created. <em class="parameter"><code>group</code></em>
 is used
as a group in the communication manager. It is allowed for <em class="parameter"><code>group</code></em>
 to have
another <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a> than <em class="parameter"><code>session</code></em>
, however, you should forward
the <a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject"><span class="type">InfCommunicationObject</span></a> messages your object receives to <em class="parameter"><code>session</code></em>
 then.
Also, <em class="parameter"><code>connection</code></em>
 must already be present in <em class="parameter"><code>group</code></em>
, and should not be
removed until synchronization finished.</p>
<p>A synchronization can only be initiated if <em class="parameter"><code>session</code></em>
 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="inf-session-synchronize-to.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> in status <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-cancel-synchronization"></a><h3>inf_session_cancel_synchronization ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_session_cancel_synchronization (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</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>Cancells an ongaing synchronization to or from <em class="parameter"><code>connection</code></em>
. If <em class="parameter"><code>session</code></em>

is in state <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>,
<em class="parameter"><code>connection</code></em>
 must match the connection that <em class="parameter"><code>session</code></em>
 is synchronizing with.
If <em class="parameter"><code>session</code></em>
 is in state <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>, <em class="parameter"><code>connection</code></em>
 can be any
connection that the session is currently being synchronized to.</p>
<p>In any case, the <a class="link" href="InfSession.html#InfSession-synchronization-failed" title="The “synchronization-failed” signal"><span class="type">“synchronization-failed”</span></a> signal will be
emitted for the cancelled synchronization. If the session is in state
<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>, the session will also
be closed, with the <a class="link" href="InfSession.html#InfSession-close" title="The “close” signal"><span class="type">“close”</span></a> signal being emited.</p>
<div class="refsect3">
<a name="inf-session-cancel-synchronization.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="InfSession.html" title="InfSession"><span class="type">InfSession</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> with which to cancel synchronization.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-get-synchronization-status"></a><h3>inf_session_get_synchronization_status ()</h3>
<pre class="programlisting"><a class="link" href="InfSession.html#InfSessionSyncStatus" title="enum InfSessionSyncStatus"><span class="returnvalue">InfSessionSyncStatus</span></a>
inf_session_get_synchronization_status
                               (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</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>If <em class="parameter"><code>session</code></em>
 is in status <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>, this always returns
<a class="link" href="InfSession.html#INF-SESSION-SYNC-IN-PROGRESS:CAPS"><code class="literal">INF_SESSION_SYNC_IN_PROGRESS</code></a> if <em class="parameter"><code>connection</code></em>
 is the connection with which
the session is synchronized, and <a class="link" href="InfSession.html#INF-SESSION-SYNC-NONE:CAPS"><code class="literal">INF_SESSION_SYNC_NONE</code></a> otherwise.</p>
<p>If <em class="parameter"><code>session</code></em>
 is in status <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>, this returns the status
of the synchronization to <em class="parameter"><code>connection</code></em>
. <a class="link" href="InfSession.html#INF-SESSION-SYNC-NONE:CAPS"><code class="literal">INF_SESSION_SYNC_NONE</code></a> is returned,
when there is currently no synchronization ongoing to <em class="parameter"><code>connection</code></em>
,
<a class="link" href="InfSession.html#INF-SESSION-SYNC-IN-PROGRESS:CAPS"><code class="literal">INF_SESSION_SYNC_IN_PROGRESS</code></a> is returned, if there is one, and
<a class="link" href="InfSession.html#INF-SESSION-SYNC-AWAITING-ACK:CAPS"><code class="literal">INF_SESSION_SYNC_AWAITING_ACK</code></a> if the synchronization is finished but we
are waiting for the acknowledgement from the remote site that all
synchronization data has been progressed successfully. The synchronization
can still fail in this state but it can no longer by cancelled.</p>
<p>If <em class="parameter"><code>session</code></em>
 is in status $INF_SESSION_CLOSED, this always returns
<a class="link" href="InfSession.html#INF-SESSION-SYNC-NONE:CAPS"><code class="literal">INF_SESSION_SYNC_NONE</code></a>.</p>
<div class="refsect3">
<a name="inf-session-get-synchronization-status.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="InfSession.html" title="InfSession"><span class="type">InfSession</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-get-synchronization-status.returns"></a><h4>Returns</h4>
<p> The synchronization status of <em class="parameter"><code>connection</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-get-synchronization-progress"></a><h3>inf_session_get_synchronization_progress ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
inf_session_get_synchronization_progress
                               (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</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>This function requires that the synchronization status of <em class="parameter"><code>connection</code></em>

is <a class="link" href="InfSession.html#INF-SESSION-SYNC-IN-PROGRESS:CAPS"><code class="literal">INF_SESSION_SYNC_IN_PROGRESS</code></a> or <a class="link" href="InfSession.html#INF-SESSION-SYNC-AWAITING-ACK:CAPS"><code class="literal">INF_SESSION_SYNC_AWAITING_ACK</code></a>
(see <a class="link" href="InfSession.html#inf-session-get-synchronization-status" title="inf_session_get_synchronization_status ()"><code class="function">inf_session_get_synchronization_status()</code></a>). Then, it returns a value
between 0.0 and 1.0 specifying how much synchronization data has already
been transferred to the remote site.</p>
<p>Note that if the session is in status <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>, it is
possible that this function returns 1.0 (i.e. all data has been
transmitted) but the synchronization is not yet complete, because the
remote site must still acknowledge the synchronization. The synchronization
then is in status <a class="link" href="InfSession.html#INF-SESSION-SYNC-AWAITING-ACK:CAPS"><code class="literal">INF_SESSION_SYNC_AWAITING_ACK</code></a>.</p>
<div class="refsect3">
<a name="inf-session-get-synchronization-progress.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="InfSession.html" title="InfSession"><span class="type">InfSession</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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-get-synchronization-progress.returns"></a><h4>Returns</h4>
<p> A value between 0.0 and 1.0.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-has-synchronizations"></a><h3>inf_session_has_synchronizations ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_session_has_synchronizations (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>);</pre>
<p>Returns whether there are currently ongoing synchronizations. If the
session is in status <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>, then this returns always
<code class="literal">TRUE</code>, if it is in <a class="link" href="InfSession.html#INF-SESSION-CLOSED:CAPS"><code class="literal">INF_SESSION_CLOSED</code></a>, then it returns always <code class="literal">FALSE</code>.
If the session is in status <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>, then it returns <code class="literal">TRUE</code>
when the session is currently at least synchronized to one connection and
<code class="literal">FALSE</code> otherwise.</p>
<div class="refsect3">
<a name="inf-session-has-synchronizations.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-has-synchronizations.returns"></a><h4>Returns</h4>
<p> Whether there are ongoing synchronizations.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-get-subscription-group"></a><h3>inf_session_get_subscription_group ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="returnvalue">InfCommunicationGroup</span></a> *
inf_session_get_subscription_group (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>);</pre>
<p>Returns the subscription group for <em class="parameter"><code>session</code></em>
, if any.</p>
<div class="refsect3">
<a name="inf-session-get-subscription-group.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-session-get-subscription-group.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>, or <code class="literal">NULL</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-set-subscription-group"></a><h3>inf_session_set_subscription_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_session_set_subscription_group (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>,
                                    <em class="parameter"><code><a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group</code></em>);</pre>
<p>Sets the subscription group for <em class="parameter"><code>session</code></em>
. The subscription group is the
group in which all connections subscribed to the session are a member of.</p>
<p><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> itself does not deal with subscriptions, so it is your job
to keep <em class="parameter"><code>group</code></em>
 up-to-date (for example if you add non-local users to
<em class="parameter"><code>session</code></em>
). This is normally done by a so-called session proxy such as
<a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> or <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>, respectively.</p>
<div class="refsect3">
<a name="inf-session-set-subscription-group.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-session-send-to-subscriptions"></a><h3>inf_session_send_to_subscriptions ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_session_send_to_subscriptions (<em class="parameter"><code><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session</code></em>,
                                   <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>Sends a XML message to the all members of <em class="parameter"><code>session</code></em>
's subscription group.
This function can only be called if the subscription group is non-<code class="literal">NULL</code>. It
takes ownership of <em class="parameter"><code>xml</code></em>
.</p>
<div class="refsect3">
<a name="inf-session-send-to-subscriptions.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="InfSession.html" title="InfSession"><span class="type">InfSession</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 message to send.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfSession.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfSessionStatus"></a><h3>enum InfSessionStatus</h3>
<p><a class="link" href="InfSession.html#InfSessionStatus" title="enum InfSessionStatus"><span class="type">InfSessionStatus</span></a> defines in what state a session is in.</p>
<div class="refsect3">
<a name="InfSessionStatus.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-SESSION-PRESYNC:CAPS"></a>INF_SESSION_PRESYNC</p></td>
<td class="enum_member_description">
<p>The session is scheduled to be synchronized from a
remote host. This can be useful if the session is needed to be present
before the actual synchronization begins. Use
<a class="link" href="InfSession.html#inf-session-synchronize-from" title="inf_session_synchronize_from ()"><code class="function">inf_session_synchronize_from()</code></a> to switch to
<a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNCHRONIZING:CAPS"></a>INF_SESSION_SYNCHRONIZING</p></td>
<td class="enum_member_description">
<p>The session is currently being synchronized
from a remote host. When done synchronizing, it will enter into
<a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a> state.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-RUNNING:CAPS"></a>INF_SESSION_RUNNING</p></td>
<td class="enum_member_description">
<p>The session is running and ready to synchronize
other hosts. If a subscription group is set
(see <a class="link" href="InfSession.html#inf-session-set-subscription-group" title="inf_session_set_subscription_group ()"><code class="function">inf_session_set_subscription_group()</code></a>), then changes to the
underlying buffer are transmitted to all subscribed connections.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-CLOSED:CAPS"></a>INF_SESSION_CLOSED</p></td>
<td class="enum_member_description">
<p>The session is closed and can no longer be used. The
session enters this state if the synchronization fails in
<a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a> state or <a class="link" href="InfSession.html#inf-session-close" title="inf_session_close ()"><code class="function">inf_session_close()</code></a> is called.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfSessionSyncStatus"></a><h3>enum InfSessionSyncStatus</h3>
<p><a class="link" href="InfSession.html#InfSessionSyncStatus" title="enum InfSessionSyncStatus"><span class="type">InfSessionSyncStatus</span></a> represents the status of a synchronization. It is
used by <a class="link" href="InfSession.html#inf-session-get-synchronization-status" title="inf_session_get_synchronization_status ()"><code class="function">inf_session_get_synchronization_status()</code></a>.</p>
<div class="refsect3">
<a name="InfSessionSyncStatus.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-SESSION-SYNC-NONE:CAPS"></a>INF_SESSION_SYNC_NONE</p></td>
<td class="enum_member_description">
<p>No synchronization is ongoing.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-IN-PROGRESS:CAPS"></a>INF_SESSION_SYNC_IN_PROGRESS</p></td>
<td class="enum_member_description">
<p>Synchronization is currently in progress.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-AWAITING-ACK:CAPS"></a>INF_SESSION_SYNC_AWAITING_ACK</p></td>
<td class="enum_member_description">
<p>All synchronization data has been sent
(progress is 1.0), but we are still waiting for an acknowledgment from the
remote site. Synchronization can no longer be cancelled, but it can stiff
fail.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfSessionSyncError"></a><h3>enum InfSessionSyncError</h3>
<p>These are errors that can occur during a synchronization of a session.
Additional errors may occur depending on the session type.</p>
<div class="refsect3">
<a name="InfSessionSyncError.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-SESSION-SYNC-ERROR-GOT-MESSAGE-IN-PRESYNC:CAPS"></a>INF_SESSION_SYNC_ERROR_GOT_MESSAGE_IN_PRESYNC</p></td>
<td class="enum_member_description">
<p>Received a message
in state <a class="link" href="InfSession.html#INF-SESSION-PRESYNC:CAPS"><code class="literal">INF_SESSION_PRESYNC</code></a>. It is not processed because
<a class="link" href="InfSession.html#inf-session-synchronize-from" title="inf_session_synchronize_from ()"><code class="function">inf_session_synchronize_from()</code></a> was not yet called.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-UNEXPECTED-NODE:CAPS"></a>INF_SESSION_SYNC_ERROR_UNEXPECTED_NODE</p></td>
<td class="enum_member_description">
<p>A message has been received that
was not understood.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-ID-NOT-PRESENT:CAPS"></a>INF_SESSION_SYNC_ERROR_ID_NOT_PRESENT</p></td>
<td class="enum_member_description">
<p>An ID was not provided for a user
in the session.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-ID-IN-USE:CAPS"></a>INF_SESSION_SYNC_ERROR_ID_IN_USE</p></td>
<td class="enum_member_description">
<p>The ID of a user is already in use by
another user.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-NAME-NOT-PRESENT:CAPS"></a>INF_SESSION_SYNC_ERROR_NAME_NOT_PRESENT</p></td>
<td class="enum_member_description">
<p>A name was not provided for a
user in the session.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-NAME-IN-USE:CAPS"></a>INF_SESSION_SYNC_ERROR_NAME_IN_USE</p></td>
<td class="enum_member_description">
<p>The name of a user is already in use
by another user.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-CONNECTION-CLOSED:CAPS"></a>INF_SESSION_SYNC_ERROR_CONNECTION_CLOSED</p></td>
<td class="enum_member_description">
<p>The synchronization connection
has been closed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-SENDER-CANCELLED:CAPS"></a>INF_SESSION_SYNC_ERROR_SENDER_CANCELLED</p></td>
<td class="enum_member_description">
<p>The sender has cancelled the
synchronization.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-RECEIVER-CANCELLED:CAPS"></a>INF_SESSION_SYNC_ERROR_RECEIVER_CANCELLED</p></td>
<td class="enum_member_description">
<p>The receiver has cancelled the
synchronization.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-UNEXPECTED-BEGIN-OF-SYNC:CAPS"></a>INF_SESSION_SYNC_ERROR_UNEXPECTED_BEGIN_OF_SYNC</p></td>
<td class="enum_member_description">
<p>Received
&lt;sync-begin/&gt;
not a the beginning of the synchronization.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-NUM-MESSAGES-MISSING:CAPS"></a>INF_SESSION_SYNC_ERROR_NUM_MESSAGES_MISSING</p></td>
<td class="enum_member_description">
<p>The &lt;sync-begin/&gt;
message does not contain the number of synchronization messages to expect.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-UNEXPECTED-END-OF-SYNC:CAPS"></a>INF_SESSION_SYNC_ERROR_UNEXPECTED_END_OF_SYNC</p></td>
<td class="enum_member_description">
<p>The &lt;sync-end/&gt;
message was not received at the end of the synchronization.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-EXPECTED-BEGIN-OF-SYNC:CAPS"></a>INF_SESSION_SYNC_ERROR_EXPECTED_BEGIN_OF_SYNC</p></td>
<td class="enum_member_description">
<p>The &lt;sync-begin/&gt;
message was not received at the beginning of the synchronization.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-EXPECTED-END-OF-SYNC:CAPS"></a>INF_SESSION_SYNC_ERROR_EXPECTED_END_OF_SYNC</p></td>
<td class="enum_member_description">
<p>The &lt;sync-end/&gt; message
was not received at the end of the synchronization.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-SESSION-SYNC-ERROR-FAILED:CAPS"></a>INF_SESSION_SYNC_ERROR_FAILED</p></td>
<td class="enum_member_description">
<p>Generic error code when no further reason
of failure is known.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfSession-struct"></a><h3>struct InfSession</h3>
<pre class="programlisting">struct InfSession;</pre>
<p><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</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="InfSessionClass"></a><h3>struct InfSessionClass</h3>
<pre class="programlisting">struct InfSessionClass {
  /* Virtual table */
  void(*to_xml_sync)(InfSession* session,
                     xmlNodePtr parent);

  gboolean(*process_xml_sync)(InfSession* session,
                              InfXmlConnection* connection,
                              xmlNodePtr xml,
                              GError** error);

  InfCommunicationScope(*process_xml_run)(InfSession* session,
                                          InfXmlConnection* connection,
                                          xmlNodePtr xml,
                                          GError** error);

  GArray*(*get_xml_user_props)(InfSession* session,
                               InfXmlConnection* conn,
                               xmlNodePtr xml);

  void (*set_xml_user_props)(InfSession* session,
                             const GParameter* params,
                             guint n_params,
                             xmlNodePtr xml);

  gboolean(*validate_user_props)(InfSession* session,
                                 const GParameter* params,
                                 guint n_params,
                                 InfUser* exclude,
                                 GError** error);

  InfUser*(*user_new)(InfSession* session,
                      GParameter* params,
                      guint n_params);

  /* Signals */
  void(*close)(InfSession* session);
  void(*error)(InfSession* session,
               InfXmlConnection* connection,
               xmlNodePtr xml,
               const GError* error);

  void(*synchronization_begin)(InfSession* session,
                               InfCommunicationGroup* group,
                               InfXmlConnection* connection);

  void(*synchronization_progress)(InfSession* session,
                                  InfXmlConnection* connection,
                                  gdouble percentage);

  void(*synchronization_complete)(InfSession* session,
                                  InfXmlConnection* connection);

  void(*synchronization_failed)(InfSession* session,
                                InfXmlConnection* connection,
                                const GError* error);
};
</pre>
<p>This structure contains the virtual functions and default signal handlers
of <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p>
<div class="refsect3">
<a name="InfSessionClass.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="InfSessionClass.to-xml-sync"></a>to_xml_sync</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function that saves the session within a XML
document. <em class="parameter"><code>parent</code></em>
is the root node of the document. It should create as
much nodes as possible within that root node and not in sub-nodes because
these are sent to a client and it is not allowed that other traffic is put
in between those nodes. This way, communication through the same connection
does not hang just because a large session is synchronized.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.process-xml-sync"></a>process_xml_sync</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function that is called for every node in the
XML document created by <em class="parameter"><code>to_xml_sync</code></em>
. It is supposed to reconstruct the
session content from the XML data.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.process-xml-run"></a>process_xml_run</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function that is called for every received
message while the session is running. Return <a class="link" href="InfCommunicationObject.html#INF-COMMUNICATION-SCOPE-GROUP:CAPS"><code class="literal">INF_COMMUNICATION_SCOPE_GROUP</code></a>
if the message is designated for all group members (see also
<a class="link" href="InfCommunicationObject.html#inf-communication-object-received" title="inf_communication_object_received ()"><code class="function">inf_communication_object_received()</code></a> on this topic).</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.get-xml-user-props"></a>get_xml_user_props</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function that creates a list of
<span class="type">GParameter</span>s for use with <code class="function">g_object_newv()</code> from a XML node.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.set-xml-user-props"></a>set_xml_user_props</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function that writes the passed user
properties into a XML node.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.validate-user-props"></a>validate_user_props</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function that checks whether the given user
properties are valid for a user join. This prevents a user join if there is
already a user with the same name. If <em class="parameter"><code>exclude</code></em>
is not <code class="literal">NULL</code>, then the
function does ignore it when validating.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.user-new"></a>user_new</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function that creates a new user object with the given
properties.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.close"></a>close</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the <a class="link" href="InfSession.html#InfSession-close" title="The “close” signal"><span class="type">“close”</span></a> signal. This
cancels currently running synchronization in <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.error"></a>error</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the <a class="link" href="InfSession.html#InfSession-error" title="The “error” signal"><span class="type">“error”</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="InfSessionClass.synchronization-begin"></a>synchronization_begin</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfSession.html#InfSession-synchronization-begin" title="The “synchronization-begin” signal"><span class="type">“synchronization-begin”</span></a> signal. The default handler queues the
synchronization messages.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.synchronization-progress"></a>synchronization_progress</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfSession.html#InfSession-synchronization-progress" title="The “synchronization-progress” signal"><span class="type">“synchronization-progress”</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="InfSessionClass.synchronization-complete"></a>synchronization_complete</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfSession.html#InfSession-synchronization-complete" title="The “synchronization-complete” signal"><span class="type">“synchronization-complete”</span></a> signal. If the session itself got
synchronized (and did not synchronize another session), then the default
handler changes status to <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfSessionClass.synchronization-failed"></a>synchronization_failed</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfSession.html#InfSession-synchronization-failed" title="The “synchronization-failed” signal"><span class="type">“synchronization-failed”</span></a> signal. If the session itself got
synchronized (and did not synchronize another session), then the default
handler changes status to <a class="link" href="InfSession.html#INF-SESSION-CLOSED:CAPS"><code class="literal">INF_SESSION_CLOSED</code></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfSession.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfSession--buffer"></a><h3>The <code class="literal">“buffer”</code> property</h3>
<pre class="programlisting">  “buffer”                   <a class="link" href="InfBuffer.html" title="InfBuffer"><span class="type">InfBuffer</span></a> *</pre>
<p>The buffer in which the document content is stored.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfSession--communication-manager"></a><h3>The <code class="literal">“communication-manager”</code> property</h3>
<pre class="programlisting">  “communication-manager”    <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *</pre>
<p>The communication manager used for sending requests.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfSession--status"></a><h3>The <code class="literal">“status”</code> property</h3>
<pre class="programlisting">  “status”                   <a class="link" href="InfSession.html#InfSessionStatus" title="enum InfSessionStatus"><span class="type">InfSessionStatus</span></a></pre>
<p>Current status of the session.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: INF_SESSION_RUNNING</p>
</div>
<hr>
<div class="refsect2">
<a name="InfSession--subscription-group"></a><h3>The <code class="literal">“subscription-group”</code> property</h3>
<pre class="programlisting">  “subscription-group”       <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *</pre>
<p>Communication group of subscribed connections.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="InfSession--sync-connection"></a><h3>The <code class="literal">“sync-connection”</code> property</h3>
<pre class="programlisting">  “sync-connection”          <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *</pre>
<p>Connection which synchronizes the initial session state.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfSession--sync-group"></a><h3>The <code class="literal">“sync-group”</code> property</h3>
<pre class="programlisting">  “sync-group”               <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *</pre>
<p>Communication group in which to perform synchronization.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfSession--user-table"></a><h3>The <code class="literal">“user-table”</code> property</h3>
<pre class="programlisting">  “user-table”               <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *</pre>
<p>User table containing the users of the session.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="InfSession.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfSession-close"></a><h3>The <code class="literal">“close”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *session,
               <span class="type">gpointer</span>    user_data)</pre>
<p>This signal is emitted if the session is closed. Note that this signal
is not called as a client if the connection to the sessions has merely
been lost, only the relevant <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> has its
<a class="link" href="InfXmlConnection.html#InfXmlConnection--status" title="The “status” property"><span class="type">“status”</span></a> property changed.</p>
<div class="refsect3">
<a name="InfSession-close.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> that is being closed</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="InfSession-error"></a><h3>The <code class="literal">“error”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>       *session,
               <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
               <span class="type">gpointer</span>          xml,
               <span class="type">gpointer</span>          error,
               <span class="type">gpointer</span>          user_data)</pre>
<p>This signal is emitted when the session detects an error. The session
itself does not know much about the nature of the error. It might mean
the session is in an inconsistent state, or it might be recoverable.
This signal can be used to handle the error or to write error
information into a log file or bring to a user's attention in another
manner.</p>
<div class="refsect3">
<a name="InfSession-error.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> having an error.</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> which sent the erroneous request.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The XML request that produced the error.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span> providing information about the error.</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="InfSession-synchronization-begin"></a><h3>The <code class="literal">“synchronization-begin”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>            *session,
               <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> *group,
               <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>      *connection,
               <span class="type">gpointer</span>               user_data)</pre>
<p>This signal is emitted whenever the session is started to be synchronized
to another connection. Note that, in contrast to
<a class="link" href="InfSession.html#InfSession-synchronization-progress" title="The “synchronization-progress” signal"><span class="type">“synchronization-progress”</span></a>,
<a class="link" href="InfSession.html#InfSession-synchronization-failed" title="The “synchronization-failed” signal"><span class="type">“synchronization-failed”</span></a> and
<a class="link" href="InfSession.html#InfSession-synchronization-complete" title="The “synchronization-complete” signal"><span class="type">“synchronization-complete”</span></a> it cannot happen that the signal
is emitted when <em class="parameter"><code>session</code></em>
 is being synchronized itself, because that can
happen at construction time only when no one had a chance to connect
signal handlers anyway.</p>
<div class="refsect3">
<a name="InfSession-synchronization-begin.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> that is synchronizing.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> used for synchronization.</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 which the session is synchronized.</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="InfSession-synchronization-complete"></a><h3>The <code class="literal">“synchronization-complete”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>       *session,
               <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
               <span class="type">gpointer</span>          user_data)</pre>
<p>This signal is emitted when synchronization has completed, in addition
to <a class="link" href="InfSession.html#InfSession-synchronization-progress" title="The “synchronization-progress” signal"><span class="type">“synchronization-progress”</span></a> with a progress value of 1.0.</p>
<p>If a callback is connected before the default handler, it can find out
whether the remote side is synchronizing the local side by comparing
<em class="parameter"><code>sessions</code></em>
's status with <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>. The default
signal handler sets the status to <a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>, so checking
afterwards is not too useful.</p>
<div class="refsect3">
<a name="InfSession-synchronization-complete.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> that has or was synchronized</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> through which synchronization happened</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="InfSession-synchronization-failed"></a><h3>The <code class="literal">“synchronization-failed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>       *session,
               <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
               <span class="type">gpointer</span>          error,
               <span class="type">gpointer</span>          user_data)</pre>
<p>This signal is emitted when synchronization has failed before its
completion due to malformed data from the other side or network failure.</p>
<p>If this happens during initial synchronization, <a class="link" href="InfSession.html#InfSession-close" title="The “close” signal"><span class="type">“close”</span></a> is
emitted as well at this point.</p>
<div class="refsect3">
<a name="InfSession-synchronization-failed.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> that failed to synchronize or be synchronized</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> through which synchronization happened</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A pointer to a <span class="type">GError</span> object with details on the error</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="InfSession-synchronization-progress"></a><h3>The <code class="literal">“synchronization-progress”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>       *session,
               <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection,
               <span class="type">gdouble</span>           progress,
               <span class="type">gpointer</span>          user_data)</pre>
<p>This signal is emitted whenever a new XML node has been sent or received
over <em class="parameter"><code>connection</code></em>
 as part of a synchronization. The process is completed
when <em class="parameter"><code>progress</code></em>
 reaches the value 1.0. At this point,
<a class="link" href="InfSession.html#InfSession-synchronization-complete" title="The “synchronization-complete” signal"><span class="type">“synchronization-complete”</span></a> is also emitted.</p>
<p>If <em class="parameter"><code>session</code></em>
's status is <a class="link" href="InfSession.html#INF-SESSION-SYNCHRONIZING:CAPS"><code class="literal">INF_SESSION_SYNCHRONIZING</code></a>, the local
side is being synchronized by the remote side. If the status is
<a class="link" href="InfSession.html#INF-SESSION-RUNNING:CAPS"><code class="literal">INF_SESSION_RUNNING</code></a>, the local side is updating the remote side.</p>
<div class="refsect3">
<a name="InfSession-synchronization-progress.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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> that is synchronizing or being synchronized</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> through which progress is made</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p>A <span class="type">gdouble</span> value ranging from 0.0 to 1.0.</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>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>