/usr/share/gtk-doc/html/libinfinity-0.6/InfXmppConnection.html is in libinfinity-0.6-doc 0.6.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfXmppConnection: 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="InfXmlConnection.html" title="InfXmlConnection">
<link rel="next" href="InfSimulatedConnection.html" title="InfSimulatedConnection">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#InfXmppConnection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfXmppConnection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfXmppConnection.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfXmppConnection.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfXmlConnection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfSimulatedConnection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfXmppConnection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfXmppConnection.top_of_page"></a>InfXmppConnection</span></h2>
<p>InfXmppConnection — Implementation of the XMPP core protocol</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfXmppConnection.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="InfXmppConnection.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="InfXmppConnection.html#InfXmppConnectionCrtCallback" title="InfXmppConnectionCrtCallback ()">*InfXmppConnectionCrtCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="returnvalue">InfXmppConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-new" title="inf_xmpp_connection_new ()">inf_xmpp_connection_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-get-tls-enabled" title="inf_xmpp_connection_get_tls_enabled ()">inf_xmpp_connection_get_tls_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gnutls_x509_crt_t</span>
</td>
<td class="function_name">
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-get-own-certificate" title="inf_xmpp_connection_get_own_certificate ()">inf_xmpp_connection_get_own_certificate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfCertificateChain.html" title="InfCertificateChain"><span class="returnvalue">InfCertificateChain</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-get-peer-certificate" title="inf_xmpp_connection_get_peer_certificate ()">inf_xmpp_connection_get_peer_certificate</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="InfXmppConnection.html#inf-xmpp-connection-set-certificate-callback" title="inf_xmpp_connection_set_certificate_callback ()">inf_xmpp_connection_set_certificate_callback</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="InfXmppConnection.html#inf-xmpp-connection-certificate-verify-continue" title="inf_xmpp_connection_certificate_verify_continue ()">inf_xmpp_connection_certificate_verify_continue</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="InfXmppConnection.html#inf-xmpp-connection-certificate-verify-cancel" title="inf_xmpp_connection_certificate_verify_cancel ()">inf_xmpp_connection_certificate_verify_cancel</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="InfXmppConnection.html#inf-xmpp-connection-reset-sasl-authentication" title="inf_xmpp_connection_reset_sasl_authentication ()">inf_xmpp_connection_reset_sasl_authentication</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="InfXmppConnection.html#inf-xmpp-connection-retry-sasl-authentication" title="inf_xmpp_connection_retry_sasl_authentication ()">inf_xmpp_connection_retry_sasl_authentication</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="InfXmppConnection.html#inf-xmpp-connection-set-sasl-error" title="inf_xmpp_connection_set_sasl_error ()">inf_xmpp_connection_set_sasl_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">GError</span> *
</td>
<td class="function_name">
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-get-sasl-error" title="inf_xmpp_connection_get_sasl_error ()">inf_xmpp_connection_get_sasl_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmppConnection.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="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *</td>
<td class="property_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection--credentials" title="The “credentials” property">credentials</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection--local-hostname" title="The “local-hostname” property">local-hostname</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection--remote-hostname" title="The “remote-hostname” property">remote-hostname</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *</td>
<td class="property_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection--sasl-context" title="The “sasl-context” property">sasl-context</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection--sasl-mechanisms" title="The “sasl-mechanisms” property">sasl-mechanisms</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a></td>
<td class="property_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection--security-policy" title="The “security-policy” property">security-policy</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="InfXmppConnection.html#InfXmppConnectionSite" title="enum InfXmppConnectionSite"><span class="type">InfXmppConnectionSite</span></a></td>
<td class="property_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection--site" title="The “site” property">site</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *</td>
<td class="property_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection--tcp-connection" title="The “tcp-connection” property">tcp-connection</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection--tls-enabled" title="The “tls-enabled” property">tls-enabled</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmppConnection.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="InfXmppConnection.html#InfXmppConnectionSite" title="enum InfXmppConnectionSite">InfXmppConnectionSite</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy">InfXmppConnectionSecurityPolicy</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfXmppConnection.html#InfXmppConnectionError" title="enum InfXmppConnectionError">InfXmppConnectionError</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfXmppConnection.html#InfXmppConnectionStreamError" title="enum InfXmppConnectionStreamError">InfXmppConnectionStreamError</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="InfXmppConnection.html#InfXmppConnectionAuthError" title="enum InfXmppConnectionAuthError">InfXmppConnectionAuthError</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfXmppConnection.html#InfXmppConnection-struct" title="struct InfXmppConnection">InfXmppConnection</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfXmppConnection.html#InfXmppConnectionClass" title="struct InfXmppConnectionClass">InfXmppConnectionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfXmppConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GEnum
<span class="lineart">├──</span> InfXmppConnectionSecurityPolicy
<span class="lineart">╰──</span> InfXmppConnectionSite
GObject
<span class="lineart">╰──</span> InfXmppConnection
</pre>
</div>
<div class="refsect1">
<a name="InfXmppConnection.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfXmppConnection implements
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection">InfXmlConnection</a>.</p>
</div>
<div class="refsect1">
<a name="InfXmppConnection.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-xmpp-connection.h>
</pre>
</div>
<div class="refsect1">
<a name="InfXmppConnection.description"></a><h2>Description</h2>
<p>This class implements the XMPP protocol as defined by RFC 3920. It handles
the authentication and authorization. Once the connection is established,
XML messages can be sent and received with the API of the
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> interface.</p>
<p>Note that any sort of XML messages can be exchanged, and that the XML does
not need to adhere to the XMPP standard. It is in the responsibility of the
user of this class to send only XML message that the remote counterpart can
understand.</p>
</div>
<div class="refsect1">
<a name="InfXmppConnection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="InfXmppConnectionCrtCallback"></a><h3>InfXmppConnectionCrtCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*InfXmppConnectionCrtCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>,
<em class="parameter"><code><span class="type">gnutls_session_t</span> session</code></em>,
<em class="parameter"><code><a class="link" href="InfCertificateChain.html" title="InfCertificateChain"><span class="type">InfCertificateChain</span></a> *chain</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Specifies the callback signature for the certificate callback set with
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-set-certificate-callback" title="inf_xmpp_connection_set_certificate_callback ()"><code class="function">inf_xmpp_connection_set_certificate_callback()</code></a>. The callback should decide
whether to trust the certificate in <em class="parameter"><code>chain</code></em>
or not.</p>
<div class="refsect3">
<a name="id-1.3.20.11.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>xmpp</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> validating a certificate.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>session</p></td>
<td class="parameter_description"><p>The underlying GnuTLS session.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>chain</p></td>
<td class="parameter_description"><p>The certificate chain presented by the remote host.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Additional data supplied when
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-set-certificate-callback" title="inf_xmpp_connection_set_certificate_callback ()"><code class="function">inf_xmpp_connection_set_certificate_callback()</code></a> was called.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-new"></a><h3>inf_xmpp_connection_new ()</h3>
<pre class="programlisting"><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="returnvalue">InfXmppConnection</span></a> *
inf_xmpp_connection_new (<em class="parameter"><code><a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *tcp</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionSite" title="enum InfXmppConnectionSite"><span class="type">InfXmppConnectionSite</span></a> site</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *local_hostname</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *remote_hostname</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> security_policy</code></em>,
<em class="parameter"><code><a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *creds</code></em>,
<em class="parameter"><code><a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *sasl_context</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *sasl_mechanisms</code></em>);</pre>
<p>Creates a new <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> with <em class="parameter"><code>tcp</code></em>
as communication channel. No
attempt is being made to open <em class="parameter"><code>tcp</code></em>
, if it is not already open. However,
communication is initiated as soon as <em class="parameter"><code>tcp</code></em>
gets into
<a class="link" href="InfTcpConnection.html#INF-TCP-CONNECTION-CONNECTED:CAPS"><code class="literal">INF_TCP_CONNECTION_CONNECTED</code></a> state, so you might still open it
lateron yourself.</p>
<p><em class="parameter"><code>local_hostname</code></em>
specifies the hostname of the local host, and
<em class="parameter"><code>remote_hostname</code></em>
specifies the hostname of the remote host, as known to
the caller. These can be a string representation of the IP address of
<em class="parameter"><code>tcp</code></em>
, or a DNS name such as "example.com". <em class="parameter"><code>local_hostname</code></em>
can be <code class="literal">NULL</code>
in which case the host name as reported by <code class="function">g_get_host_name()</code> is used.</p>
<p><em class="parameter"><code>creds</code></em>
may be <code class="literal">NULL</code> in which case the connection creates the credentials
as soon as they are required. However, this only works if
<em class="parameter"><code>site</code></em>
is <a class="link" href="InfXmppConnection.html#INF-XMPP-CONNECTION-CLIENT:CAPS"><code class="literal">INF_XMPP_CONNECTION_CLIENT</code></a> or <em class="parameter"><code>security_policy</code></em>
is
<a class="link" href="InfXmppConnection.html#INF-XMPP-CONNECTION-SECURITY-ONLY-UNSECURED:CAPS"><code class="literal">INF_XMPP_CONNECTION_SECURITY_ONLY_UNSECURED</code></a> (or both, of course). For
server connections <em class="parameter"><code>creds</code></em>
must contain a valid server certificate in case
<em class="parameter"><code>security_policy</code></em>
is not <a class="link" href="InfXmppConnection.html#INF-XMPP-CONNECTION-SECURITY-ONLY-UNSECURED:CAPS"><code class="literal">INF_XMPP_CONNECTION_SECURITY_ONLY_UNSECURED</code></a>.
<em class="parameter"><code>creds</code></em>
can contain a certificate for the client site and, if so, is used
for client authentication.</p>
<p>If <em class="parameter"><code>sasl_context</code></em>
is <code class="literal">NULL</code>, <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> uses a built-in context
that only supports ANONYMOUS authentication. In <em class="parameter"><code>sasl_context</code></em>
's
callback function, the <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> for which the authentication
shall be performed can be accessed via the <em class="parameter"><code>session_data</code></em>
parameter of
<a class="link" href="InfSaslContext.html#InfSaslContextCallbackFunc" title="InfSaslContextCallbackFunc ()"><span class="type">InfSaslContextCallbackFunc</span></a>.</p>
<p>If <em class="parameter"><code>sasl_context</code></em>
is not <code class="literal">NULL</code>, then the <em class="parameter"><code>sasl_mechanisms</code></em>
parameter defines
what SASL mechanisms are used. On the server side, these are the mechanisms
offered to the client, and on the client side, these are the accepted
mechanisms (meaning that if a server does not offer any of these, the
connection will be closed). If <em class="parameter"><code>sasl_context</code></em>
is <code class="literal">NULL</code>, then this parameter
is ignored. <em class="parameter"><code>sasl_mechanisms</code></em>
can be <code class="literal">NULL</code> in which case all available
mechanisms are accepted or offered, respectively.</p>
<div class="refsect3">
<a name="id-1.3.20.11.3.9"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tcp</p></td>
<td class="parameter_description"><p>The underlaying TCP connection to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>site</p></td>
<td class="parameter_description"><p>Whether this is a XMPP client or server.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>local_hostname</p></td>
<td class="parameter_description"><p>The hostname of the local host, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>remote_hostname</p></td>
<td class="parameter_description"><p>The hostname of the remote host.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>security_policy</p></td>
<td class="parameter_description"><p>Whether to use (or offer, as a server) TLS. See
<a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> for the meaning of this parameter.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>creds</p></td>
<td class="parameter_description"><p>Certificate credentials used to secure the communication.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sasl_context</p></td>
<td class="parameter_description"><p>A SASL context used for authentication.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sasl_mechanisms</p></td>
<td class="parameter_description"><p>A whitespace-separated list of SASL mechanisms to
accept/offer, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.20.11.3.10"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-get-tls-enabled"></a><h3>inf_xmpp_connection_get_tls_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_xmpp_connection_get_tls_enabled (<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>);</pre>
<p>Returns whether TLS encryption is enabled for <em class="parameter"><code>xmpp</code></em>
. This returns <code class="literal">TRUE</code>
as soon as the TLS handshake is completed but before the server certificate
was verified (see <a class="link" href="InfXmppConnection.html#inf-xmpp-connection-set-certificate-callback" title="inf_xmpp_connection_set_certificate_callback ()"><code class="function">inf_xmpp_connection_set_certificate_callback()</code></a>).</p>
<div class="refsect3">
<a name="id-1.3.20.11.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.20.11.4.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if TLS is enabled and <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-get-own-certificate"></a><h3>inf_xmpp_connection_get_own_certificate ()</h3>
<pre class="programlisting"><span class="returnvalue">gnutls_x509_crt_t</span>
inf_xmpp_connection_get_own_certificate
(<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>);</pre>
<p>Returns the local host's certificate that was used to authenticate with
the remote host, or <code class="literal">NULL</code> if no certificate was used. This function can
only be used after the TLS handshake has completed, see
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-get-tls-enabled" title="inf_xmpp_connection_get_tls_enabled ()"><code class="function">inf_xmpp_connection_get_tls_enabled()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.20.11.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.20.11.5.6"></a><h4>Returns</h4>
<p> The certificate of the local host. The returned value should not
be freed, it is owned by the <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-get-peer-certificate"></a><h3>inf_xmpp_connection_get_peer_certificate ()</h3>
<pre class="programlisting"><a class="link" href="InfCertificateChain.html" title="InfCertificateChain"><span class="returnvalue">InfCertificateChain</span></a> *
inf_xmpp_connection_get_peer_certificate
(<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>);</pre>
<p>Returns the certificate chain that the remote host authenticated itself
with. This function can only be used after the TLS handshake has completed,
see <a class="link" href="InfXmppConnection.html#inf-xmpp-connection-get-tls-enabled" title="inf_xmpp_connection_get_tls_enabled ()"><code class="function">inf_xmpp_connection_get_tls_enabled()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.20.11.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.20.11.6.6"></a><h4>Returns</h4>
<p> The certificate chain of the remote host. The returned value
should not be freed, it is owned by the <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-set-certificate-callback"></a><h3>inf_xmpp_connection_set_certificate_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xmpp_connection_set_certificate_callback
(<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>,
<em class="parameter"><code><span class="type">gnutls_certificate_request_t</span> req</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionCrtCallback" title="InfXmppConnectionCrtCallback ()"><span class="type">InfXmppConnectionCrtCallback</span></a> cb</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>This function sets a callback that is called when the connection needs to
verify the peer's certificate. It does not need to respond immediately,
but can, for example, show a dialog to a user and continue when the user
finished with it.</p>
<p>When the certificate is trusted, then call
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-certificate-verify-continue" title="inf_xmpp_connection_certificate_verify_continue ()"><code class="function">inf_xmpp_connection_certificate_verify_continue()</code></a>,
otherwise <a class="link" href="InfXmppConnection.html#inf-xmpp-connection-certificate-verify-cancel" title="inf_xmpp_connection_certificate_verify_cancel ()"><code class="function">inf_xmpp_connection_certificate_verify_cancel()</code></a>. This can happen
in the callback or some time later. The connection process is stopped until
either of these functions is called.</p>
<p>Note that the function is also called if the peer did not send a
certificate, in which case the certificate chain parameter in the callback
will be <code class="literal">NULL</code>.</p>
<p>If <em class="parameter"><code>cb</code></em>
is <code class="literal">NULL</code>, or this function has not been called before a certificate
needs to be verified, then the certificate is always trusted.</p>
<div class="refsect3">
<a name="id-1.3.20.11.7.8"></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>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>req</p></td>
<td class="parameter_description"><p>Whether to request a client certificate from the peer.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cb</p></td>
<td class="parameter_description"><p>Function to be called to verify the peer's certificate, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Additional data to pass to the callback function.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-certificate-verify-continue"></a><h3>inf_xmpp_connection_certificate_verify_continue ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xmpp_connection_certificate_verify_continue
(<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>);</pre>
<p>Call this function when your callback set in
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-set-certificate-callback" title="inf_xmpp_connection_set_certificate_callback ()"><code class="function">inf_xmpp_connection_set_certificate_callback()</code></a> was called and you do trust
the peer's certificate. The connection process will then continue.</p>
<div class="refsect3">
<a name="id-1.3.20.11.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-certificate-verify-cancel"></a><h3>inf_xmpp_connection_certificate_verify_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xmpp_connection_certificate_verify_cancel
(<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
<p>Call this function when your callback set in
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-set-certificate-callback" title="inf_xmpp_connection_set_certificate_callback ()"><code class="function">inf_xmpp_connection_set_certificate_callback()</code></a> was called and you do not
trust the peer's certificate. The connection will then be closed with a
corresponding error.</p>
<p>If <em class="parameter"><code>error</code></em>
is non-<code class="literal">NULL</code>, then it should contain a reason why the certificate
was not trusted. If you verified the peer's certificate with
<code class="function">gnutls_certificate_verify_peers2()</code>, or <code class="function">gnutls_x509_crt_list_verify()</code>, then
a corresponding error can be generated with the verification result
with <a class="link" href="libinfinity-0.6-InfError.html#inf-gnutls-certificate-verification-set-error" title="inf_gnutls_certificate_verification_set_error ()"><code class="function">inf_gnutls_certificate_verification_set_error()</code></a>. The reason is then
shown to the local user.</p>
<div class="refsect3">
<a name="id-1.3.20.11.9.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Reason why the certificate is not trusted, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-reset-sasl-authentication"></a><h3>inf_xmpp_connection_reset_sasl_authentication ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xmpp_connection_reset_sasl_authentication
(<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>,
<em class="parameter"><code><a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *new_context</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *new_mechanisms</code></em>);</pre>
<p>Sets a new SASL context and mechanisms to use for authentication. This does
not have any effect if authentication has already been performed. This can
be useful if a server decides to use a stricter authentication policy and
gets away with its previous SASL context. If <em class="parameter"><code>new_context</code></em>
is <code class="literal">NULL</code>, then a
built-in SASL context is used which only accepts anonymous authentication.</p>
<p>If the authentication is currently in progress then it is aborted. The
server sends an <a class="link" href="InfXmppConnection.html#INF-XMPP-CONNECTION-AUTH-ERROR-TEMPORARY-AUTH-FAILURE:CAPS"><code class="literal">INF_XMPP_CONNECTION_AUTH_ERROR_TEMPORARY_AUTH_FAILURE</code></a>
error to the client with <a class="link" href="libinfinity-0.6-InfError.html#INF-AUTHENTICATION-DETAIL-ERROR-TRY-AGAIN:CAPS"><code class="literal">INF_AUTHENTICATION_DETAIL_ERROR_TRY_AGAIN</code></a> detail
(see <a class="link" href="InfXmppConnection.html#inf-xmpp-connection-get-sasl-error" title="inf_xmpp_connection_get_sasl_error ()"><code class="function">inf_xmpp_connection_get_sasl_error()</code></a>).</p>
<p>On the client side, if authentication is in progress, a request to abort
the authentication is sent to the server. The server will then reply with
an <a class="link" href="InfXmppConnection.html#INF-XMPP-CONNECTION-AUTH-ERROR-ABORTED:CAPS"><code class="literal">INF_XMPP_CONNECTION_AUTH_ERROR_ABORTED</code></a> error. In the signal handler of
the <a class="link" href="InfXmlConnection.html#InfXmlConnection-error" title="The “error” signal"><span class="type">“error”</span></a> signal you should reinitiate the authentication
with <a class="link" href="InfXmppConnection.html#inf-xmpp-connection-retry-sasl-authentication" title="inf_xmpp_connection_retry_sasl_authentication ()"><code class="function">inf_xmpp_connection_retry_sasl_authentication()</code></a> or the connection will
be closed. It is also possible that the final authentication request has
already been sent, and the server replies with successful authentication
instead. In that case calling this function will have no effect apart from
closing and reopening the connection will use the new context and
mechanisms.</p>
<div class="refsect3">
<a name="id-1.3.20.11.10.7"></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>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_context</p></td>
<td class="parameter_description"><p>The new sasl context to set, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_mechanisms</p></td>
<td class="parameter_description"><p>Allowed SASL mechanisms to use. Ignored if <em class="parameter"><code>new_context</code></em>
is <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-retry-sasl-authentication"></a><h3>inf_xmpp_connection_retry_sasl_authentication ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_xmpp_connection_retry_sasl_authentication
(<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>When SASL authentication failed then the <a class="link" href="InfXmlConnection.html#InfXmlConnection-error" title="The “error” signal"><span class="type">“error”</span></a> signal
is emitted with an error from the INF_XMPP_CONNECTION_AUTH_ERROR domain.
If the signal handler wants to retry authentication then it should call
this function, possibly modifying the <a class="link" href="InfXmppConnection.html#InfXmppConnection--sasl-mechanisms" title="The “sasl-mechanisms” property"><span class="type">“sasl-mechanisms”</span></a>
property before. If this function is not called then the connection will
terminate.</p>
<p>The function can fail if the server does not support any of the available
mechanisms given in <a class="link" href="InfXmppConnection.html#InfXmppConnection--sasl-mechanisms" title="The “sasl-mechanisms” property"><span class="type">“sasl-mechanisms”</span></a>. If so, the function
returns <code class="literal">FALSE</code> and <em class="parameter"><code>error</code></em>
is set.</p>
<div class="refsect3">
<a name="id-1.3.20.11.11.6"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.20.11.11.7"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if auth retry is being performed, <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-set-sasl-error"></a><h3>inf_xmpp_connection_set_sasl_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_xmpp_connection_set_sasl_error (<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
<p>Sets the SASL error of <em class="parameter"><code>xmpp</code></em>
. The SASL error is an additional hint of what
went wrong during authentication. It should be set on the server side
in the gsasl callback checking the user authentication. If on the
client side <a class="link" href="InfXmlConnection.html#InfXmlConnection-error" title="The “error” signal"><span class="type">“error”</span></a> is emitted with an error from the
INF_XMPP_CONNECTION_AUTH_ERROR domain then
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-get-sasl-error" title="inf_xmpp_connection_get_sasl_error ()"><code class="function">inf_xmpp_connection_get_sasl_error()</code></a> can be used to obtain more detailed
error information.</p>
<div class="refsect3">
<a name="id-1.3.20.11.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>The SASL error to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-xmpp-connection-get-sasl-error"></a><h3>inf_xmpp_connection_get_sasl_error ()</h3>
<pre class="programlisting">const <span class="returnvalue">GError</span> *
inf_xmpp_connection_get_sasl_error (<em class="parameter"><code><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> *xmpp</code></em>);</pre>
<p>Gets the SASL error of <em class="parameter"><code>xmpp</code></em>
. See <a class="link" href="InfXmppConnection.html#inf-xmpp-connection-set-sasl-error" title="inf_xmpp_connection_set_sasl_error ()"><code class="function">inf_xmpp_connection_set_sasl_error()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.20.11.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>xmpp</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.20.11.13.6"></a><h4>Returns</h4>
<p> A pointer to a <span class="type">GError</span> object owned by <em class="parameter"><code>xmpp</code></em>
.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfXmppConnection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfXmppConnectionSite"></a><h3>enum InfXmppConnectionSite</h3>
<p>Specifies whether the local site of the connection is a client or a
server.</p>
<div class="refsect3">
<a name="id-1.3.20.12.2.4"></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-XMPP-CONNECTION-SERVER:CAPS"></a>INF_XMPP_CONNECTION_SERVER</p></td>
<td class="enum_member_description">
<p>The local site of this connection is an
XMPP server and the remote counterpart is a client.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-CLIENT:CAPS"></a>INF_XMPP_CONNECTION_CLIENT</p></td>
<td class="enum_member_description">
<p>The local site of this connection is a
XMPP client and the remote counterpart is a server.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnectionSecurityPolicy"></a><h3>enum InfXmppConnectionSecurityPolicy</h3>
<p>The <a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> enumeration specifies various options
of how to deal with the other site allowing or requiring TLS-secured
connections. Note that if the local site is a server, then
<em class="parameter"><code>INF_XMPP_CONNECTION_SECURITY_BOTH_PREFER_UNSECURED</code></em>
and
<em class="parameter"><code>INF_XMPP_CONNECTION_SECURITY_BOTH_PREFER_TLS</code></em>
are equivalent.</p>
<div class="refsect3">
<a name="id-1.3.20.12.3.4"></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-XMPP-CONNECTION-SECURITY-ONLY-UNSECURED:CAPS"></a>INF_XMPP_CONNECTION_SECURITY_ONLY_UNSECURED</p></td>
<td class="enum_member_description">
<p>In the case of a server, do
not offer TLS to the client. As a client, only connect if the server does
not require TLS.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-SECURITY-ONLY-TLS:CAPS"></a>INF_XMPP_CONNECTION_SECURITY_ONLY_TLS</p></td>
<td class="enum_member_description">
<p>In the case of a server, require
all connections to be TLS-secured. As a client, only connect if the server
supports TLS.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-SECURITY-BOTH-PREFER-UNSECURED:CAPS"></a>INF_XMPP_CONNECTION_SECURITY_BOTH_PREFER_UNSECURED</p></td>
<td class="enum_member_description">
<p>In the case of a
server, offer both unsecured and secured messaging to the client. As a
client, use unsecured communication unless TLS is required by the server.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-SECURITY-BOTH-PREFER-TLS:CAPS"></a>INF_XMPP_CONNECTION_SECURITY_BOTH_PREFER_TLS</p></td>
<td class="enum_member_description">
<p>In the case of a server,
offer both unsecured and secured messaging to the client. As a client,
use TLS unless not supported by the server.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnectionError"></a><h3>enum InfXmppConnectionError</h3>
<p>Specifies the error codes in the
<code class="literal">INF_XMPP_CONNECTION_ERROR</code> error domain.</p>
<div class="refsect3">
<a name="id-1.3.20.12.4.4"></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-XMPP-CONNECTION-ERROR-TLS-UNSUPPORTED:CAPS"></a>INF_XMPP_CONNECTION_ERROR_TLS_UNSUPPORTED</p></td>
<td class="enum_member_description">
<p>Server does not support TLS,
but the security policy is set to <a class="link" href="InfXmppConnection.html#INF-XMPP-CONNECTION-SECURITY-ONLY-TLS:CAPS"><code class="literal">INF_XMPP_CONNECTION_SECURITY_ONLY_TLS</code></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-ERROR-TLS-REQUIRED:CAPS"></a>INF_XMPP_CONNECTION_ERROR_TLS_REQUIRED</p></td>
<td class="enum_member_description">
<p>The server requires TLS, but the
security policy is set to <a class="link" href="InfXmppConnection.html#INF-XMPP-CONNECTION-SECURITY-ONLY-UNSECURED:CAPS"><code class="literal">INF_XMPP_CONNECTION_SECURITY_ONLY_UNSECURED</code></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-ERROR-TLS-FAILURE:CAPS"></a>INF_XMPP_CONNECTION_ERROR_TLS_FAILURE</p></td>
<td class="enum_member_description">
<p>Server cannot proceed with the TLS
handshake.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-ERROR-NO-CERTIFICATE-PROVIDED:CAPS"></a>INF_XMPP_CONNECTION_ERROR_NO_CERTIFICATE_PROVIDED</p></td>
<td class="enum_member_description">
<p>The server did not
provide a certificate.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-ERROR-CERTIFICATE-NOT-TRUSTED:CAPS"></a>INF_XMPP_CONNECTION_ERROR_CERTIFICATE_NOT_TRUSTED</p></td>
<td class="enum_member_description">
<p>The server certificate
is not trusted. Whether the server certificate is trusted or not is defined
by the API user, by providing a certificate callback with
<a class="link" href="InfXmppConnection.html#inf-xmpp-connection-set-certificate-callback" title="inf_xmpp_connection_set_certificate_callback ()"><code class="function">inf_xmpp_connection_set_certificate_callback()</code></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-ERROR-AUTHENTICATION-UNSUPPORTED:CAPS"></a>INF_XMPP_CONNECTION_ERROR_AUTHENTICATION_UNSUPPORTED</p></td>
<td class="enum_member_description">
<p>The server does not
provide any authentication mechanisms.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-ERROR-NO-SUITABLE-MECHANISM:CAPS"></a>INF_XMPP_CONNECTION_ERROR_NO_SUITABLE_MECHANISM</p></td>
<td class="enum_member_description">
<p>The server does not offer
a suitable authentication mechanism that is accepted by the client.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-ERROR-FAILED:CAPS"></a>INF_XMPP_CONNECTION_ERROR_FAILED</p></td>
<td class="enum_member_description">
<p>General error code for otherwise
unknown errors.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnectionStreamError"></a><h3>enum InfXmppConnectionStreamError</h3>
<p>Specifies the error codes in the
<code class="literal">INF_XMPP_CONNECTION_STREAM_ERROR</code> error domain. These
errors correspond to the ones defined in RFC 3920, section 4.7.3.</p>
<div class="refsect3">
<a name="id-1.3.20.12.5.4"></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-XMPP-CONNECTION-STREAM-ERROR-BAD-FORMAT:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_BAD_FORMAT</p></td>
<td class="enum_member_description">
<p>The entity has sent XML that
cannot be processed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-BAD-NAMESPACE-PREFIX:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_BAD_NAMESPACE_PREFIX</p></td>
<td class="enum_member_description">
<p>The entity has sent
a namespace prefix that is unsupported, or has sent no namespace prefix on
an element that requires such a prefix.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-CONFLICT:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_CONFLICT</p></td>
<td class="enum_member_description">
<p>The server is closing the
active stream for this entity because a new stream has been initiated
that conflicts with the existing stream.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-CONNECTION-TIMEOUT:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_CONNECTION_TIMEOUT</p></td>
<td class="enum_member_description">
<p>The entity has not
generated any traffic over the stream for some period of time.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-HOST-GONE:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_HOST_GONE</p></td>
<td class="enum_member_description">
<p>The value of the 'to'
attribute provided by the initiating entity in the stream header
corresponds to a hostname that is no longer hosted by the server.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-HOST-UNKNOWN:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_HOST_UNKNOWN</p></td>
<td class="enum_member_description">
<p>The value of the 'to'
attribute provided by the initiating entity in the stream header does
not correspond to a hostname that is hosted by the server.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-IMPROPER-ADDRESSING:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_IMPROPER_ADDRESSING</p></td>
<td class="enum_member_description">
<p>A stanza sent
between two servers lacks a 'to' or 'from' attribute.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-INTERNAL-SERVER-ERROR:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_INTERNAL_SERVER_ERROR</p></td>
<td class="enum_member_description">
<p>The server has
experienced a misconfiguration or an otherwise-undefined internal error
that prevents it from servicing the stream.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-INVALID-FROM:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_INVALID_FROM</p></td>
<td class="enum_member_description">
<p>The JID or hostname
provided in a 'from' address does not match an authorized JID or
validated domain negotiated between servers via SASL or dialback, or
between a client and a server via authentication and resource binding.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-INVALID-ID:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_INVALID_ID</p></td>
<td class="enum_member_description">
<p>The stream ID or dialback
ID is invalid or does not match an ID previously provided.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-INVALID-NAMESPACE:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_INVALID_NAMESPACE</p></td>
<td class="enum_member_description">
<p>The streams namespace
is something other than <code class="literal">http://etherx.jabber.org/streams</code>
or the dialback namespace name is something other than
<code class="literal">jabber:server:dialback</code>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-INVALID-XML:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_INVALID_XML</p></td>
<td class="enum_member_description">
<p>The entity has sent invalid
XML over the stream to a server that performs validation.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-NOT-AUTHORIZED:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_NOT_AUTHORIZED</p></td>
<td class="enum_member_description">
<p>The entity has attempted
to send data before the stream has been authenticated, or otherwise is not
authorized to perform an action related to stream negotiation.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-POLICY-VIOLATION:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_POLICY_VIOLATION</p></td>
<td class="enum_member_description">
<p>The entity has violated
some local service policy.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-REMOTE-CONNECTION-FAILED:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_REMOTE_CONNECTION_FAILED</p></td>
<td class="enum_member_description">
<p>The server is
unable to properly connect to a remote entity that is required for
authentication or authorization.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-RESOURCE-CONSTRAINT:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_RESOURCE_CONSTRAINT</p></td>
<td class="enum_member_description">
<p>The server lacks the
system resources necessary to service the stream.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-RESTRICTED-XML:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_RESTRICTED_XML</p></td>
<td class="enum_member_description">
<p>The entity has attempted
to send restricted XML features.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-SEE-OTHER-HOST:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_SEE_OTHER_HOST</p></td>
<td class="enum_member_description">
<p>The server will not
provide service to the initiating entity but is redirecting traffic
to another host.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-SYSTEM-SHUTDOWN:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_SYSTEM_SHUTDOWN</p></td>
<td class="enum_member_description">
<p>The server is being
shut down and all active streams are being closed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-UNDEFINED-CONDITION:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_UNDEFINED_CONDITION</p></td>
<td class="enum_member_description">
<p>The error condition
is not one of those defined by the other conditions.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-UNSUPPORTED-ENCODING:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_UNSUPPORTED_ENCODING</p></td>
<td class="enum_member_description">
<p>The initiating
entity has encoded the stream in an encoding that is not supported by
the server.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-UNSUPPORTED-STANZA-TYPE:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_UNSUPPORTED_STANZA_TYPE</p></td>
<td class="enum_member_description">
<p>The initiating
entity has sent a first-level child of the stream that is not supported
by the server.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-UNSUPPORTED-VERSION:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_UNSUPPORTED_VERSION</p></td>
<td class="enum_member_description">
<p>The value of the
'version' attribute provided by the initiating entity in the stream header
specifies a version of XMPP that is not supported by the server.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-XML-NOT-WELL-FORMED:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_XML_NOT_WELL_FORMED</p></td>
<td class="enum_member_description">
<p>The initiating
entity has sent XML that is not well-formed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-STREAM-ERROR-FAILED:CAPS"></a>INF_XMPP_CONNECTION_STREAM_ERROR_FAILED</p></td>
<td class="enum_member_description">
<p>General error code for otherwise
unknown errors.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnectionAuthError"></a><h3>enum InfXmppConnectionAuthError</h3>
<p>Specifies the error codes in the
<code class="literal">INF_XMPP_CONNECTION_AUTH_ERROR</code> error domain. These
errors correspond to the ones defined in RFC 3920, section 6.4.</p>
<div class="refsect3">
<a name="id-1.3.20.12.6.4"></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-XMPP-CONNECTION-AUTH-ERROR-ABORTED:CAPS"></a>INF_XMPP_CONNECTION_AUTH_ERROR_ABORTED</p></td>
<td class="enum_member_description">
<p>The receiving entity acknowledged
an <code class="literal"><abort/></code> element sent by the initiating entity.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-AUTH-ERROR-INCORRECT-ENCODING:CAPS"></a>INF_XMPP_CONNECTION_AUTH_ERROR_INCORRECT_ENCODING</p></td>
<td class="enum_member_description">
<p>The data provided by
the initiating entity could not be processed because the Base64 encoding
is incorrect.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-AUTH-ERROR-INVALID-AUTHZID:CAPS"></a>INF_XMPP_CONNECTION_AUTH_ERROR_INVALID_AUTHZID</p></td>
<td class="enum_member_description">
<p>The authzid provided by
the initiating entity is invalid, either because it is incorrectly
formatted or because the initiating entity does not have permissions
to authorize that ID.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-AUTH-ERROR-INVALID-MECHANISM:CAPS"></a>INF_XMPP_CONNECTION_AUTH_ERROR_INVALID_MECHANISM</p></td>
<td class="enum_member_description">
<p>The initiating entity
did not provide a mechanism or requested a mechanism that is not supported
by the receiving entity.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-AUTH-ERROR-MECHANISM-TOO-WEAK:CAPS"></a>INF_XMPP_CONNECTION_AUTH_ERROR_MECHANISM_TOO_WEAK</p></td>
<td class="enum_member_description">
<p>The mechanism requsted
by the initiating entity is weaker than server policy permits for that
initiating entity.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-AUTH-ERROR-NOT-AUTHORIZED:CAPS"></a>INF_XMPP_CONNECTION_AUTH_ERROR_NOT_AUTHORIZED</p></td>
<td class="enum_member_description">
<p>The authentication failed
because the initiating entity did not provide valid credentials.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-AUTH-ERROR-TEMPORARY-AUTH-FAILURE:CAPS"></a>INF_XMPP_CONNECTION_AUTH_ERROR_TEMPORARY_AUTH_FAILURE</p></td>
<td class="enum_member_description">
<p>The authentication
failed because of a temporary error condition within the receiving entity.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-XMPP-CONNECTION-AUTH-ERROR-FAILED:CAPS"></a>INF_XMPP_CONNECTION_AUTH_ERROR_FAILED</p></td>
<td class="enum_member_description">
<p>General error code for otherwise
unknown errors.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnection-struct"></a><h3>struct InfXmppConnection</h3>
<pre class="programlisting">struct InfXmppConnection;</pre>
<p><a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</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="InfXmppConnectionClass"></a><h3>struct InfXmppConnectionClass</h3>
<pre class="programlisting">struct InfXmppConnectionClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
<div class="refsect1">
<a name="InfXmppConnection.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfXmppConnection--credentials"></a><h3>The <code class="literal">“credentials”</code> property</h3>
<pre class="programlisting"> “credentials” <a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *</pre>
<p>The certificate credentials for GnuTLS.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnection--local-hostname"></a><h3>The <code class="literal">“local-hostname”</code> property</h3>
<pre class="programlisting"> “local-hostname” <span class="type">gchar</span> *</pre>
<p>The hostname of the local host.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnection--remote-hostname"></a><h3>The <code class="literal">“remote-hostname”</code> property</h3>
<pre class="programlisting"> “remote-hostname” <span class="type">gchar</span> *</pre>
<p>The hostname of the remote host.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnection--sasl-context"></a><h3>The <code class="literal">“sasl-context”</code> property</h3>
<pre class="programlisting"> “sasl-context” <a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *</pre>
<p>The SASL context used for authentication.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnection--sasl-mechanisms"></a><h3>The <code class="literal">“sasl-mechanisms”</code> property</h3>
<pre class="programlisting"> “sasl-mechanisms” <span class="type">gchar</span> *</pre>
<p>Whitespace separated list of SASL mechanisms to accept/offer.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnection--security-policy"></a><h3>The <code class="literal">“security-policy”</code> property</h3>
<pre class="programlisting"> “security-policy” <a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a></pre>
<p>How to choose whether to use (or offer, as a server) TLS.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: INF_XMPP_CONNECTION_SECURITY_BOTH_PREFER_TLS</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnection--site"></a><h3>The <code class="literal">“site”</code> property</h3>
<pre class="programlisting"> “site” <a class="link" href="InfXmppConnection.html#InfXmppConnectionSite" title="enum InfXmppConnectionSite"><span class="type">InfXmppConnectionSite</span></a></pre>
<p>Site of the connection (client or server).</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: INF_XMPP_CONNECTION_CLIENT</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnection--tcp-connection"></a><h3>The <code class="literal">“tcp-connection”</code> property</h3>
<pre class="programlisting"> “tcp-connection” <a class="link" href="InfTcpConnection.html" title="InfTcpConnection"><span class="type">InfTcpConnection</span></a> *</pre>
<p>Underlaying TCP connection.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfXmppConnection--tls-enabled"></a><h3>The <code class="literal">“tls-enabled”</code> property</h3>
<pre class="programlisting"> “tls-enabled” <span class="type">gboolean</span></pre>
<p>Whether TLS is enabled for the connection or not.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|