/usr/share/proton-0.14.0/docs/api-py/proton.Messenger-class.html is in python-qpid-proton-doc 0.14.0-5.1ubuntu1.
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 | <?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>proton.Messenger</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="proton-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="proton-module.html">Package proton</a> ::
Class Messenger
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="proton.Messenger-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Messenger</h1><p class="nomargin-top"><span class="codelink"><a href="proton-pysrc.html#Messenger">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">Messenger</strong>
</pre>
<hr />
<p>The <a href="proton.Messenger-class.html" class="link">Messenger</a>
class defines a high level interface for sending and receiving <a
href="proton.Message-class.html" class="link">Messages</a>. Every <a
href="proton.Messenger-class.html" class="link">Messenger</a> contains a
single logical queue of incoming messages and a single logical queue of
outgoing messages. These messages in these queues may be destined for, or
originate from, a variety of addresses.</p>
<p>The messenger interface is single-threaded. All methods except one
(<a href="proton.Messenger-class.html#interrupt"
class="link">interrupt</a>) are intended to be used from within the
messenger thread.</p>
<h1 class="heading">Address Syntax</h1>
<p>An address has the following form:</p>
<pre class="literalblock">
[ amqp[s]:// ] [user[:password]@] domain [/[name]]
</pre>
<p>Where domain can be one of:</p>
<pre class="literalblock">
host | host:port | ip | ip:port | name
</pre>
<p>The following are valid examples of addresses:</p>
<ul>
<li>
example.org
</li>
<li>
example.org:1234
</li>
<li>
amqp://example.org
</li>
<li>
amqps://example.org
</li>
<li>
example.org/incoming
</li>
<li>
amqps://example.org/outgoing
</li>
<li>
amqps://fred:trustno1@example.org
</li>
<li>
127.0.0.1:1234
</li>
<li>
amqps://127.0.0.1:1234
</li>
</ul>
<h1 class="heading">Sending & Receiving Messages</h1>
<p>The <a href="proton.Messenger-class.html" class="link">Messenger</a>
class works in conjuction with the <a href="proton.Message-class.html"
class="link">Message</a> class. The <a href="proton.Message-class.html"
class="link">Message</a> class is a mutable holder of message
content.</p>
<p>The <a href="proton.Messenger-class.html#put" class="link">put</a>
method copies its <a href="proton.Message-class.html"
class="link">Message</a> to the outgoing queue, and may send queued
messages if it can do so without blocking. The <a
href="proton.Messenger-class.html#send" class="link">send</a> method
blocks until it has sent the requested number of messages, or until a
timeout interrupts the attempt.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>message = Message()
<span class="py-prompt">>>> </span><span class="py-keyword">for</span> i <span class="py-keyword">in</span> range(3):
<span class="py-more">... </span> message.address = <span class="py-string">"amqp://host/queue"</span>
<span class="py-more">... </span> message.subject = <span class="py-string">"Hello World %i"</span> % i
<span class="py-more">... </span> messenger.put(message)
<span class="py-prompt">>>> </span>messenger.send()</pre>
<p>Similarly, the <a href="proton.Messenger-class.html#recv"
class="link">recv</a> method receives messages into the incoming queue,
and may block as it attempts to receive the requested number of
messages, or until timeout is reached. It may receive fewer than the
requested number. The <a href="proton.Messenger-class.html#get"
class="link">get</a> method pops the eldest <a
href="proton.Message-class.html" class="link">Message</a> off the
incoming queue and copies it into the <a
href="proton.Message-class.html" class="link">Message</a> object that
you supply. It will not block.</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>message = Message()
<span class="py-prompt">>>> </span>messenger.recv(10):
<span class="py-prompt">>>> </span>while messenger.incoming > 0:
<span class="py-more">... </span> messenger.get(message)
<span class="py-more">... </span> <span class="py-keyword">print</span> message.subject
<span class="py-output">Hello World 0</span>
<span class="py-output">Hello World 1</span>
<span class="py-output">Hello World 2</span></pre>
<p>The blocking flag allows you to turn off blocking behavior entirely,
in which case <a href="proton.Messenger-class.html#send"
class="link">send</a> and <a href="proton.Messenger-class.html#recv"
class="link">recv</a> will do whatever they can without blocking, and
then return. You can then look at the number of incoming and outgoing
messages to see how much outstanding work still remains.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>)</span><br />
Construct a new <a href="proton.Messenger-class.html"
class="link">Messenger</a> with the given name.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#__del__" class="summary-sig-name">__del__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Destroy the <a href="proton.Messenger-class.html"
class="link">Messenger</a>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.__del__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#start" class="summary-sig-name">start</a>(<span class="summary-sig-arg">self</span>)</span><br />
Currently a no-op placeholder.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.start">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#stop" class="summary-sig-name">stop</a>(<span class="summary-sig-arg">self</span>)</span><br />
Transitions the <a href="proton.Messenger-class.html"
class="link">Messenger</a> to an inactive state.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.stop">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#subscribe" class="summary-sig-name">subscribe</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">source</span>)</span><br />
Subscribes the <a href="proton.Messenger-class.html"
class="link">Messenger</a> to messages originating from the specified
source.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.subscribe">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#put" class="summary-sig-name">put</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">message</span>)</span><br />
Places the content contained in the message onto the outgoing queue
of the <a href="proton.Messenger-class.html"
class="link">Messenger</a>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.put">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#status" class="summary-sig-name">status</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tracker</span>)</span><br />
Gets the last known remote state of the delivery associated with the
given tracker.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.status">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#buffered" class="summary-sig-name">buffered</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tracker</span>)</span><br />
Checks if the delivery associated with the given tracker is still
waiting to be sent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.buffered">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#settle" class="summary-sig-name">settle</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tracker</span>=<span class="summary-sig-default">None</span>)</span><br />
Frees a <a href="proton.Messenger-class.html"
class="link">Messenger</a> from tracking the status associated with a
given tracker.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.settle">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#send" class="summary-sig-name">send</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">n</span>=<span class="summary-sig-default">-1</span>)</span><br />
This call will block until the indicated number of <a
href="proton.Message-class.html" class="link">messages</a> have been
sent, or until the operation times out.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.send">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#recv" class="summary-sig-name">recv</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">n</span>=<span class="summary-sig-default">None</span>)</span><br />
Receives up to <i>n</i> <a href="proton.Message-class.html"
class="link">messages</a> into the incoming queue.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.recv">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#work" class="summary-sig-name">work</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span><br />
Sends or receives any outstanding <a href="proton.Message-class.html"
class="link">messages</a> queued for a <a
href="proton.Messenger-class.html" class="link">Messenger</a>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.work">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#interrupt" class="summary-sig-name">interrupt</a>(<span class="summary-sig-arg">self</span>)</span><br />
The <a href="proton.Messenger-class.html" class="link">Messenger</a>
interface is single-threaded.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.interrupt">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">message</span>=<span class="summary-sig-default">None</span>)</span><br />
Moves the message from the head of the incoming message queue into
the supplied message object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.get">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#accept" class="summary-sig-name">accept</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tracker</span>=<span class="summary-sig-default">None</span>)</span><br />
Signal the sender that you have acted on the <a
href="proton.Message-class.html" class="link">Message</a> pointed to
by the tracker.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.accept">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#reject" class="summary-sig-name">reject</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tracker</span>=<span class="summary-sig-default">None</span>)</span><br />
Rejects the <a href="proton.Message-class.html"
class="link">Message</a> indicated by the tracker.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.reject">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#route" class="summary-sig-name">route</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">pattern</span>,
<span class="summary-sig-arg">address</span>)</span><br />
Adds a routing rule to a <a href="proton.Messenger-class.html"
class="link">Messenger's</a> internal routing table.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.route">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="proton.Messenger-class.html#rewrite" class="summary-sig-name">rewrite</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">pattern</span>,
<span class="summary-sig-arg">address</span>)</span><br />
Similar to route(), except that the destination of the <a
href="proton.Message-class.html" class="link">Message</a> is
determined before the message address is rewritten.</td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.rewrite">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="selectable"></a><span class="summary-sig-name">selectable</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="proton-pysrc.html#Messenger.selectable">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#name" class="summary-name">name</a><br />
The name of the <a href="proton.Messenger-class.html"
class="link">Messenger</a>.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#certificate" class="summary-name">certificate</a><br />
Path to a certificate file for the <a
href="proton.Messenger-class.html" class="link">Messenger</a>.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#private_key" class="summary-name">private_key</a><br />
Path to a private key file for the <a
href="proton.Messenger-class.html" class="link">Messenger's</a>
certificate.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#password" class="summary-name">password</a><br />
This property contains the password for the <a
href="proton.Messenger-class.html#private_key"
class="link">Messenger.private_key</a> file, or None if the file is
not encrypted.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#trusted_certificates" class="summary-name">trusted_certificates</a><br />
A path to a database of trusted certificates for use in verifying the
peer on an SSL/TLS connection.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#timeout" class="summary-name">timeout</a><br />
The timeout property contains the default timeout for blocking
operations performed by the <a href="proton.Messenger-class.html"
class="link">Messenger</a>.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#blocking" class="summary-name">blocking</a><br />
Enable or disable blocking behavior during <a
href="proton.Message-class.html" class="link">Message</a> sending and
receiving.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#passive" class="summary-name">passive</a><br />
When passive is set to true, Messenger will not attempt to perform
I/O internally.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#incoming_window" class="summary-name">incoming_window</a><br />
The incoming tracking window for the messenger.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#outgoing_window" class="summary-name">outgoing_window</a><br />
The outgoing tracking window for the messenger.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#stopped" class="summary-name">stopped</a><br />
Returns true iff a <a href="proton.Messenger-class.html"
class="link">Messenger</a> is in the stopped state.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#receiving" class="summary-name">receiving</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#outgoing" class="summary-name">outgoing</a><br />
The outgoing queue depth.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#incoming" class="summary-name">incoming</a><br />
The incoming queue depth.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="proton.Messenger-class.html#deadline" class="summary-name">deadline</a>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.__init__">source code</a></span>
</td>
</tr></table>
<p>Construct a new <a href="proton.Messenger-class.html"
class="link">Messenger</a> with the given name. The name has global
scope. If a NULL name is supplied, a UUID based name will be chosen.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (string) - the name of the messenger or None</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__del__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__del__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Destructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.__del__">source code</a></span>
</td>
</tr></table>
<p>Destroy the <a href="proton.Messenger-class.html"
class="link">Messenger</a>. This will close all connections that are
managed by the <a href="proton.Messenger-class.html"
class="link">Messenger</a>. Call the <a
href="proton.Messenger-class.html#stop" class="link">stop</a> method
before destroying the <a href="proton.Messenger-class.html"
class="link">Messenger</a>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="start"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">start</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.start">source code</a></span>
</td>
</tr></table>
<p>Currently a no-op placeholder. For future compatibility, do not <a
href="proton.Messenger-class.html#send" class="link">send</a> or <a
href="proton.Messenger-class.html#recv" class="link">recv</a> messages
before starting the <a href="proton.Messenger-class.html"
class="link">Messenger</a>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="stop"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">stop</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.stop">source code</a></span>
</td>
</tr></table>
<p>Transitions the <a href="proton.Messenger-class.html"
class="link">Messenger</a> to an inactive state. An inactive <a
href="proton.Messenger-class.html" class="link">Messenger</a> will not
send or receive messages from its internal queues. A <a
href="proton.Messenger-class.html" class="link">Messenger</a> should be
stopped before being discarded to ensure a clean shutdown handshake
occurs on any internally managed connections.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="subscribe"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">subscribe</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">source</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.subscribe">source code</a></span>
</td>
</tr></table>
<p>Subscribes the <a href="proton.Messenger-class.html"
class="link">Messenger</a> to messages originating from the specified
source. The source is an address as specified in the <a
href="proton.Messenger-class.html" class="link">Messenger</a>
introduction with the following addition. If the domain portion of the
address begins with the '~' character, the <a
href="proton.Messenger-class.html" class="link">Messenger</a> will
interpret the domain as host/port, bind to it, and listen for incoming
messages. For example "~0.0.0.0", "amqp://~0.0.0.0",
and "amqps://~0.0.0.0" will all bind to any local interface and
listen for incoming messages with the last variant only permitting
incoming SSL connections.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>source</code></strong> (string) - the source of messages to subscribe to</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="put"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">put</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">message</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.put">source code</a></span>
</td>
</tr></table>
<p>Places the content contained in the message onto the outgoing queue of
the <a href="proton.Messenger-class.html" class="link">Messenger</a>.
This method will never block, however it will send any unblocked <a
href="proton.Message-class.html" class="link">Messages</a> in the
outgoing queue immediately and leave any blocked <a
href="proton.Message-class.html" class="link">Messages</a> remaining in
the outgoing queue. The <a href="proton.Messenger-class.html#send"
class="link">send</a> call may be used to block until the outgoing queue
is empty. The <a href="proton.Messenger-class.html#outgoing"
class="link">outgoing</a> property may be used to check the depth of the
outgoing queue.</p>
<p>When the content in a given <a href="proton.Message-class.html"
class="link">Message</a> object is copied to the outgoing message queue,
you may then modify or discard the <a href="proton.Message-class.html"
class="link">Message</a> object without having any impact on the content
in the outgoing queue.</p>
<p>This method returns an outgoing tracker for the <a
href="proton.Message-class.html" class="link">Message</a>. The tracker
can be used to determine the delivery status of the <a
href="proton.Message-class.html" class="link">Message</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>message</code></strong> (Message) - the message to place in the outgoing queue</li>
</ul></dd>
<dt>Returns:</dt>
<dd>a tracker</dd>
</dl>
</td></tr></table>
</div>
<a name="status"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">status</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tracker</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.status">source code</a></span>
</td>
</tr></table>
<p>Gets the last known remote state of the delivery associated with the
given tracker.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tracker</code></strong> (tracker) - the tracker whose status is to be retrieved</li>
</ul></dd>
<dt>Returns:</dt>
<dd>one of None, PENDING, REJECTED, MODIFIED, or ACCEPTED</dd>
</dl>
</td></tr></table>
</div>
<a name="buffered"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">buffered</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tracker</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.buffered">source code</a></span>
</td>
</tr></table>
<p>Checks if the delivery associated with the given tracker is still
waiting to be sent.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tracker</code></strong> (tracker) - the tracker whose status is to be retrieved</li>
</ul></dd>
<dt>Returns:</dt>
<dd>true if delivery is still buffered</dd>
</dl>
</td></tr></table>
</div>
<a name="settle"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">settle</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tracker</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.settle">source code</a></span>
</td>
</tr></table>
<p>Frees a <a href="proton.Messenger-class.html"
class="link">Messenger</a> from tracking the status associated with a
given tracker. If you don't supply a tracker, all outgoing <a
href="proton.Message-class.html" class="link">messages</a> up to the most
recent will be settled.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="send"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">send</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">n</span>=<span class="sig-default">-1</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.send">source code</a></span>
</td>
</tr></table>
<p>This call will block until the indicated number of <a
href="proton.Message-class.html" class="link">messages</a> have been
sent, or until the operation times out. If n is -1 this call will block
until all outgoing <a href="proton.Message-class.html"
class="link">messages</a> have been sent. If n is 0 then this call will
send whatever it can without blocking.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="recv"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">recv</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">n</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.recv">source code</a></span>
</td>
</tr></table>
<p>Receives up to <i>n</i> <a href="proton.Message-class.html"
class="link">messages</a> into the incoming queue. If no value for
<i>n</i> is supplied, this call will receive as many <a
href="proton.Message-class.html" class="link">messages</a> as it can
buffer internally. If the <a href="proton.Messenger-class.html"
class="link">Messenger</a> is in blocking mode, this call will block
until at least one <a href="proton.Message-class.html"
class="link">Message</a> is available in the incoming queue.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="work"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">work</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">timeout</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.work">source code</a></span>
</td>
</tr></table>
<p>Sends or receives any outstanding <a href="proton.Message-class.html"
class="link">messages</a> queued for a <a
href="proton.Messenger-class.html" class="link">Messenger</a>. This will
block for the indicated timeout. This method may also do I/O work other
than sending and receiving <a href="proton.Message-class.html"
class="link">messages</a>. For example, closing connections after
messenger.<a href="proton.Messenger-class.html#stop"
class="link">stop</a>() has been called.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="interrupt"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">interrupt</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.interrupt">source code</a></span>
</td>
</tr></table>
<p>The <a href="proton.Messenger-class.html" class="link">Messenger</a>
interface is single-threaded. This is the only <a
href="proton.Messenger-class.html" class="link">Messenger</a> function
intended to be called from outside of the <a
href="proton.Messenger-class.html" class="link">Messenger</a> thread.
Call this from a non-messenger thread to interrupt a <a
href="proton.Messenger-class.html" class="link">Messenger</a> that is
blocking. This will cause any in-progress blocking call to throw the <a
href="proton.Interrupt-class.html" class="link">Interrupt</a> exception.
If there is no currently blocking call, then the next blocking call will
be affected, even if it is within the same thread that interrupt was
called from.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="get"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">message</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.get">source code</a></span>
</td>
</tr></table>
<p>Moves the message from the head of the incoming message queue into the
supplied message object. Any content in the message will be
overwritten.</p>
<p>A tracker for the incoming <a href="proton.Message-class.html"
class="link">Message</a> is returned. The tracker can later be used to
communicate your acceptance or rejection of the <a
href="proton.Message-class.html" class="link">Message</a>.</p>
<p>If None is passed in for the <a href="proton.Message-class.html"
class="link">Message</a> object, the <a href="proton.Message-class.html"
class="link">Message</a> popped from the head of the queue is
discarded.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>message</code></strong> (Message) - the destination message object</li>
</ul></dd>
<dt>Returns:</dt>
<dd>a tracker</dd>
</dl>
</td></tr></table>
</div>
<a name="accept"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">accept</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tracker</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.accept">source code</a></span>
</td>
</tr></table>
<p>Signal the sender that you have acted on the <a
href="proton.Message-class.html" class="link">Message</a> pointed to by
the tracker. If no tracker is supplied, then all messages that have been
returned by the <a href="proton.Messenger-class.html#get"
class="link">get</a> method are accepted, except those that have already
been auto-settled by passing beyond your incoming window size.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tracker</code></strong> (tracker) - a tracker as returned by get</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="reject"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">reject</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">tracker</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.reject">source code</a></span>
</td>
</tr></table>
<p>Rejects the <a href="proton.Message-class.html"
class="link">Message</a> indicated by the tracker. If no tracker is
supplied, all messages that have been returned by the <a
href="proton.Messenger-class.html#get" class="link">get</a> method are
rejected, except those that have already been auto-settled by passing
beyond your outgoing window size.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>tracker</code></strong> (tracker) - a tracker as returned by get</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="route"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">route</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">pattern</span>,
<span class="sig-arg">address</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.route">source code</a></span>
</td>
</tr></table>
<p>Adds a routing rule to a <a href="proton.Messenger-class.html"
class="link">Messenger's</a> internal routing table.</p>
<p>The route procedure may be used to influence how a <a
href="proton.Messenger-class.html" class="link">Messenger</a> will
internally treat a given address or class of addresses. Every call to the
route procedure will result in <a href="proton.Messenger-class.html"
class="link">Messenger</a> appending a routing rule to its internal
routing table.</p>
<p>Whenever a <a href="proton.Message-class.html"
class="link">Message</a> is presented to a <a
href="proton.Messenger-class.html" class="link">Messenger</a> for
delivery, it will match the address of this message against the set of
routing rules in order. The first rule to match will be triggered, and
instead of routing based on the address presented in the message, the <a
href="proton.Messenger-class.html" class="link">Messenger</a> will route
based on the address supplied in the rule.</p>
<p>The pattern matching syntax supports two types of matches, a '%' will
match any character except a '/', and a '*' will match any character
including a '/'.</p>
<p>A routing address is specified as a normal AMQP address, however it
may additionally use substitution variables from the pattern match that
triggered the rule.</p>
<p>Any message sent to "foo" will be routed to
"amqp://foo.com":</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>messenger.route(<span class="py-string">"foo"</span>, <span class="py-string">"amqp://foo.com"</span>);</pre>
<p>Any message sent to "foobar" will be routed to
"amqp://foo.com/bar":</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>messenger.route(<span class="py-string">"foobar"</span>, <span class="py-string">"amqp://foo.com/bar"</span>);</pre>
<p>Any message sent to bar/<path> will be routed to the
corresponding path within the amqp://bar.com domain:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>messenger.route(<span class="py-string">"bar/*"</span>, <span class="py-string">"amqp://bar.com/$1"</span>);</pre>
<p>Route all <a href="proton.Message-class.html"
class="link">messages</a> over TLS:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>messenger.route(<span class="py-string">"amqp:*"</span>, <span class="py-string">"amqps:$1"</span>)</pre>
<p>Supply credentials for foo.com:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>messenger.route(<span class="py-string">"amqp://foo.com/*"</span>, <span class="py-string">"amqp://user:password@foo.com/$1"</span>);</pre>
<p>Supply credentials for all domains:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>messenger.route(<span class="py-string">"amqp://*"</span>, <span class="py-string">"amqp://user:password@$1"</span>);</pre>
<p>Route all addresses through a single proxy while preserving the
original destination:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>messenger.route(<span class="py-string">"amqp://%/*"</span>, <span class="py-string">"amqp://user:password@proxy/$1/$2"</span>);</pre>
<p>Route any address through a single broker:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>messenger.route(<span class="py-string">"*"</span>, <span class="py-string">"amqp://user:password@broker/$1"</span>);</pre>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="rewrite"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">rewrite</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">pattern</span>,
<span class="sig-arg">address</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="proton-pysrc.html#Messenger.rewrite">source code</a></span>
</td>
</tr></table>
<p>Similar to route(), except that the destination of the <a
href="proton.Message-class.html" class="link">Message</a> is determined
before the message address is rewritten.</p>
<p>The outgoing address is only rewritten after routing has been
finalized. If a message has an outgoing address of
"amqp://0.0.0.0:5678", and a rewriting rule that changes its
outgoing address to "foo", it will still arrive at the peer
that is listening on "amqp://0.0.0.0:5678", but when it arrives
there, the receiver will see its outgoing address as "foo".</p>
<p>The default rewrite rule removes username and password from addresses
before they are transmitted.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Property Details</span></td>
</tr>
</table>
<a name="name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">name</h3>
<p>The name of the <a href="proton.Messenger-class.html"
class="link">Messenger</a>.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.name(<span class="summary-sig-arg">self</span>)</span>
- The name of the <a href="proton.Messenger-class.html"
class="link">Messenger</a>.
</dd>
</dl>
</td></tr></table>
</div>
<a name="certificate"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">certificate</h3>
<p>Path to a certificate file for the <a
href="proton.Messenger-class.html" class="link">Messenger</a>. This
certificate is used when the <a href="proton.Messenger-class.html"
class="link">Messenger</a> accepts or establishes SSL/TLS connections.
This property must be specified for the <a
href="proton.Messenger-class.html" class="link">Messenger</a> to accept
incoming SSL/TLS connections and to establish client authenticated
outgoing SSL/TLS connection. Non client authenticated outgoing SSL/TLS
connections do not require this property.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_get_certificate" class="summary-sig-name" onclick="show_private();">_get_certificate</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_set_certificate" class="summary-sig-name" onclick="show_private();">_set_certificate</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="private_key"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">private_key</h3>
<p>Path to a private key file for the <a
href="proton.Messenger-class.html" class="link">Messenger's</a>
certificate. This property must be specified for the <a
href="proton.Messenger-class.html" class="link">Messenger</a> to accept
incoming SSL/TLS connections and to establish client authenticated
outgoing SSL/TLS connection. Non client authenticated SSL/TLS connections
do not require this property.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_get_private_key" class="summary-sig-name" onclick="show_private();">_get_private_key</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_set_private_key" class="summary-sig-name" onclick="show_private();">_set_private_key</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="password"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">password</h3>
<p>This property contains the password for the <a
href="proton.Messenger-class.html#private_key"
class="link">Messenger.private_key</a> file, or None if the file is not
encrypted.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_get_password" class="summary-sig-name" onclick="show_private();">_get_password</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_set_password" class="summary-sig-name" onclick="show_private();">_set_password</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="trusted_certificates"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">trusted_certificates</h3>
<p>A path to a database of trusted certificates for use in verifying the
peer on an SSL/TLS connection. If this property is None, then the peer
will not be verified.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_get_trusted_certificates" class="summary-sig-name" onclick="show_private();">_get_trusted_certificates</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_set_trusted_certificates" class="summary-sig-name" onclick="show_private();">_set_trusted_certificates</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="timeout"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">timeout</h3>
<p>The timeout property contains the default timeout for blocking
operations performed by the <a href="proton.Messenger-class.html"
class="link">Messenger</a>.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_get_timeout" class="summary-sig-name" onclick="show_private();">_get_timeout</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_set_timeout" class="summary-sig-name" onclick="show_private();">_set_timeout</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="blocking"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">blocking</h3>
<p>Enable or disable blocking behavior during <a
href="proton.Message-class.html" class="link">Message</a> sending and
receiving. This affects every blocking call, with the exception of <a
href="proton.Messenger-class.html#work" class="link">work</a>.
Currently, the affected calls are <a
href="proton.Messenger-class.html#send" class="link">send</a>, <a
href="proton.Messenger-class.html#recv" class="link">recv</a>, and <a
href="proton.Messenger-class.html#stop" class="link">stop</a>.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_is_blocking" class="summary-sig-name" onclick="show_private();">_is_blocking</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_set_blocking" class="summary-sig-name" onclick="show_private();">_set_blocking</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">b</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="passive"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">passive</h3>
<p>When passive is set to true, Messenger will not attempt to perform I/O
internally. In this mode it is necessary to use the selectables API to
drive any I/O needed to perform requested actions. In this mode Messenger
will never block.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_is_passive" class="summary-sig-name" onclick="show_private();">_is_passive</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_set_passive" class="summary-sig-name" onclick="show_private();">_set_passive</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">b</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="incoming_window"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">incoming_window</h3>
<p>The incoming tracking window for the messenger. The messenger will
track the remote status of this many incoming deliveries after they have
been accepted or rejected. Defaults to zero.</p>
<p><a href="proton.Message-class.html" class="link">Messages</a> enter
this window only when you take them into your application using <a
href="proton.Messenger-class.html#get" class="link">get</a>. If your
incoming window size is <i>n</i>, and you get <i>n</i>+1 <a
href="proton.Message-class.html" class="link">messages</a> without
explicitly accepting or rejecting the oldest message, then the message
that passes beyond the edge of the incoming window will be assigned the
default disposition of its link.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_get_incoming_window" class="summary-sig-name" onclick="show_private();">_get_incoming_window</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_set_incoming_window" class="summary-sig-name" onclick="show_private();">_set_incoming_window</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">window</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="outgoing_window"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">outgoing_window</h3>
<p>The outgoing tracking window for the messenger. The messenger will
track the remote status of this many outgoing deliveries after calling
send. Defaults to zero.</p>
<p>A <a href="proton.Message-class.html" class="link">Message</a> enters
this window when you call the put() method with the message. If your
outgoing window size is <i>n</i>, and you call <a
href="proton.Messenger-class.html#put" class="link">put</a> <i>n</i>+1
times, status information will no longer be available for the first
message.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_get_outgoing_window" class="summary-sig-name" onclick="show_private();">_get_outgoing_window</a>(<span class="summary-sig-arg">self</span>)</span>
</dd>
<dt>Set Method:</dt>
<dd class="value"><span class="summary-sig"><a href="proton.Messenger-class.html#_set_outgoing_window" class="summary-sig-name" onclick="show_private();">_set_outgoing_window</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">window</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="stopped"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">stopped</h3>
<p>Returns true iff a <a href="proton.Messenger-class.html"
class="link">Messenger</a> is in the stopped state. This function does
not block.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.stopped(<span class="summary-sig-arg">self</span>)</span>
- Returns true iff a <a href="proton.Messenger-class.html"
class="link">Messenger</a> is in the stopped state.
</dd>
</dl>
</td></tr></table>
</div>
<a name="receiving"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">receiving</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.receiving(<span class="summary-sig-arg">self</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<a name="outgoing"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">outgoing</h3>
<p>The outgoing queue depth.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.outgoing(<span class="summary-sig-arg">self</span>)</span>
- The outgoing queue depth.
</dd>
</dl>
</td></tr></table>
</div>
<a name="incoming"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">incoming</h3>
<p>The incoming queue depth.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.incoming(<span class="summary-sig-arg">self</span>)</span>
- The incoming queue depth.
</dd>
</dl>
</td></tr></table>
</div>
<a name="deadline"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">deadline</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.deadline(<span class="summary-sig-arg">self</span>)</span>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="proton-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1
on Sun Feb 4 22:16:50 2018
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|