/usr/share/doc/python-pika-doc/html/modules/channel.html is in python-pika-doc 0.11.0-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Channel — pika 0.11.0 documentation</title>
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.11.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Connection" href="connection.html" />
<link rel="prev" title="Twisted Connection Adapter" href="adapters/twisted.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="connection.html" title="Connection"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="adapters/twisted.html" title="Twisted Connection Adapter"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pika 0.11.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Core Class and Module Documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pika.channel">
<span id="channel"></span><h1>Channel<a class="headerlink" href="#module-pika.channel" title="Permalink to this headline">¶</a></h1>
<p>The Channel class provides a wrapper for interacting with RabbitMQ
implementing the methods and behaviors for an AMQP Channel.</p>
<div class="section" id="id1">
<h2>Channel<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="pika.channel.Channel">
<em class="property">class </em><code class="descclassname">pika.channel.</code><code class="descname">Channel</code><span class="sig-paren">(</span><em>connection</em>, <em>channel_number</em>, <em>on_open_callback</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel" title="Permalink to this definition">¶</a></dt>
<dd><p>A Channel is the primary communication method for interacting with
RabbitMQ. It is recommended that you do not directly invoke
the creation of a channel object in your application code but rather
construct the a channel by calling the active connection’s channel()
method.</p>
<dl class="method">
<dt id="pika.channel.Channel.add_callback">
<code class="descname">add_callback</code><span class="sig-paren">(</span><em>callback</em>, <em>replies</em>, <em>one_shot=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.add_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Pass in a callback handler and a list replies from the
RabbitMQ broker which you’d like the callback notified of. Callbacks
should allow for the frame parameter to be passed in.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call</li>
<li><strong>replies</strong> (<em>list</em>) – The replies to get a callback for</li>
<li><strong>one_shot</strong> (<em>bool</em>) – Only handle the first type callback</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.add_on_cancel_callback">
<code class="descname">add_on_cancel_callback</code><span class="sig-paren">(</span><em>callback</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.add_on_cancel_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Pass a callback function that will be called when the basic_cancel
is sent by the server. The callback function should receive a frame
parameter.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> (<em>callable</em>) – The callback to call on Basic.Cancel from
broker</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.add_on_close_callback">
<code class="descname">add_on_close_callback</code><span class="sig-paren">(</span><em>callback</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.add_on_close_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Pass a callback function that will be called when the channel is
closed. The callback function will receive the channel, the
reply_code (int) and the reply_text (int) describing why the channel was
closed.</p>
<p>If the channel is closed by broker via Channel.Close, the callback will
receive the reply_code/reply_text provided by the broker.</p>
<p>If channel closing is initiated by user (either directly of indirectly
by closing a connection containing the channel) and closing
concludes gracefully without Channel.Close from the broker and without
loss of connection, the callback will receive 0 as reply_code and empty
string as reply_text.</p>
<p>If channel was closed due to loss of connection, the callback will
receive reply_code and reply_text representing the loss of connection.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> (<em>callable</em>) – The callback, having the signature:
callback(Channel, int reply_code, str reply_text)</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.add_on_flow_callback">
<code class="descname">add_on_flow_callback</code><span class="sig-paren">(</span><em>callback</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.add_on_flow_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Pass a callback function that will be called when Channel.Flow is
called by the remote server. Note that newer versions of RabbitMQ
will not issue this but instead use TCP backpressure</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> (<em>callable</em>) – The callback function</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.add_on_return_callback">
<code class="descname">add_on_return_callback</code><span class="sig-paren">(</span><em>callback</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.add_on_return_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Pass a callback function that will be called when basic_publish as
sent a message that has been rejected and returned by the server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> (<em>callable</em>) – The function to call, having the signature
callback(channel, method, properties, body)
where
channel: pika.Channel
method: pika.spec.Basic.Return
properties: pika.spec.BasicProperties
body: str, unicode, or bytes (python 3.x)</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.basic_ack">
<code class="descname">basic_ack</code><span class="sig-paren">(</span><em>delivery_tag=0</em>, <em>multiple=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.basic_ack" title="Permalink to this definition">¶</a></dt>
<dd><p>Acknowledge one or more messages. When sent by the client, this
method acknowledges one or more messages delivered via the Deliver or
Get-Ok methods. When sent by server, this method acknowledges one or
more messages published with the Publish method on a channel in
confirm mode. The acknowledgement can be for a single message or a
set of messages up to and including a specific message.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>delivery_tag</strong> (<em>integer</em>) – int/long The server-assigned delivery tag</li>
<li><strong>multiple</strong> (<em>bool</em>) – If set to True, the delivery tag is treated as
“up to and including”, so that multiple messages
can be acknowledged with a single method. If set
to False, the delivery tag refers to a single
message. If the multiple field is 1, and the
delivery tag is zero, this indicates
acknowledgement of all outstanding messages.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.basic_cancel">
<code class="descname">basic_cancel</code><span class="sig-paren">(</span><em>callback=None</em>, <em>consumer_tag=''</em>, <em>nowait=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.basic_cancel" title="Permalink to this definition">¶</a></dt>
<dd><p>This method cancels a consumer. This does not affect already
delivered messages, but it does mean the server will not send any more
messages for that consumer. The client may receive an arbitrary number
of messages in between sending the cancel method and receiving the
cancel-ok reply. It may also be sent from the server to the client in
the event of the consumer being unexpectedly cancelled (i.e. cancelled
for any reason other than the server receiving the corresponding
basic.cancel from the client). This allows clients to be notified of
the loss of consumers due to events such as queue deletion.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>callback</strong> (<em>callable</em>) – Callback to call for a Basic.CancelOk
response; MUST be None when nowait=True. MUST be callable when
nowait=False.</li>
<li><strong>consumer_tag</strong> (<em>str</em>) – Identifier for the consumer</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not expect a Basic.CancelOk response</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – </p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.basic_consume">
<code class="descname">basic_consume</code><span class="sig-paren">(</span><em>consumer_callback</em>, <em>queue=''</em>, <em>no_ack=False</em>, <em>exclusive=False</em>, <em>consumer_tag=None</em>, <em>arguments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.basic_consume" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends the AMQP 0-9-1 command Basic.Consume to the broker and binds messages
for the consumer_tag to the consumer callback. If you do not pass in
a consumer_tag, one will be automatically generated for you. Returns
the consumer tag.</p>
<p>For more information on basic_consume, see:
Tutorial 2 at <a class="reference external" href="http://www.rabbitmq.com/getstarted.html">http://www.rabbitmq.com/getstarted.html</a>
<a class="reference external" href="http://www.rabbitmq.com/confirms.html">http://www.rabbitmq.com/confirms.html</a>
<a class="reference external" href="http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.consume">http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.consume</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>consumer_callback</strong> (<em>callable</em>) – <p>The function to call when consuming
with the signature consumer_callback(channel, method, properties,</p>
<blockquote>
<div><blockquote>
<div>body), where</div></blockquote>
<p>channel: pika.Channel
method: pika.spec.Basic.Deliver
properties: pika.spec.BasicProperties
body: str, unicode, or bytes (python 3.x)</p>
</div></blockquote>
</li>
<li><strong>queue</strong> (<em>str</em><em> or </em><em>unicode</em>) – The queue to consume from</li>
<li><strong>no_ack</strong> (<em>bool</em>) – if set to True, automatic acknowledgement mode will be used
(see <a class="reference external" href="http://www.rabbitmq.com/confirms.html">http://www.rabbitmq.com/confirms.html</a>)</li>
<li><strong>exclusive</strong> (<em>bool</em>) – Don’t allow other consumers on the queue</li>
<li><strong>consumer_tag</strong> (<em>str</em><em> or </em><em>unicode</em>) – Specify your own consumer tag</li>
<li><strong>arguments</strong> (<em>dict</em>) – Custom key/value pair arguments for the consumer</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.basic_get">
<code class="descname">basic_get</code><span class="sig-paren">(</span><em>callback=None</em>, <em>queue=''</em>, <em>no_ack=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.basic_get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a single message from the AMQP broker. If you want to
be notified of Basic.GetEmpty, use the Channel.add_callback method
adding your Basic.GetEmpty callback which should expect only one
parameter, frame. Due to implementation details, this cannot be called
a second time until the callback is executed. For more information on
basic_get and its parameters, see:</p>
<p><a class="reference external" href="http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.get">http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.get</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call with a message that has
the signature callback(channel, method, properties, body), where:
channel: pika.Channel
method: pika.spec.Basic.GetOk
properties: pika.spec.BasicProperties
body: str, unicode, or bytes (python 3.x)</li>
<li><strong>queue</strong> (<em>str</em><em> or </em><em>unicode</em>) – The queue to get a message from</li>
<li><strong>no_ack</strong> (<em>bool</em>) – Tell the broker to not expect a reply</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.basic_nack">
<code class="descname">basic_nack</code><span class="sig-paren">(</span><em>delivery_tag=None</em>, <em>multiple=False</em>, <em>requeue=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.basic_nack" title="Permalink to this definition">¶</a></dt>
<dd><p>This method allows a client to reject one or more incoming messages.
It can be used to interrupt and cancel large incoming messages, or
return untreatable messages to their original queue.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>delivery-tag</strong> (<em>integer</em>) – int/long The server-assigned delivery tag</li>
<li><strong>multiple</strong> (<em>bool</em>) – If set to True, the delivery tag is treated as
“up to and including”, so that multiple messages
can be acknowledged with a single method. If set
to False, the delivery tag refers to a single
message. If the multiple field is 1, and the
delivery tag is zero, this indicates
acknowledgement of all outstanding messages.</li>
<li><strong>requeue</strong> (<em>bool</em>) – If requeue is true, the server will attempt to
requeue the message. If requeue is false or the
requeue attempt fails the messages are discarded or
dead-lettered.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.basic_publish">
<code class="descname">basic_publish</code><span class="sig-paren">(</span><em>exchange</em>, <em>routing_key</em>, <em>body</em>, <em>properties=None</em>, <em>mandatory=False</em>, <em>immediate=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.basic_publish" title="Permalink to this definition">¶</a></dt>
<dd><p>Publish to the channel with the given exchange, routing key and body.
For more information on basic_publish and what the parameters do, see:</p>
<p><a class="reference external" href="http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.publish">http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.publish</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>exchange</strong> (<em>str</em><em> or </em><em>unicode</em>) – The exchange to publish to</li>
<li><strong>routing_key</strong> (<em>str</em><em> or </em><em>unicode</em>) – The routing key to bind on</li>
<li><strong>body</strong> (<em>str</em><em> or </em><em>unicode</em>) – The message body</li>
<li><strong>properties</strong> (<a class="reference internal" href="spec.html#pika.spec.BasicProperties" title="pika.spec.BasicProperties"><em>pika.spec.BasicProperties</em></a>) – Basic.properties</li>
<li><strong>mandatory</strong> (<em>bool</em>) – The mandatory flag</li>
<li><strong>immediate</strong> (<em>bool</em>) – The immediate flag</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.basic_qos">
<code class="descname">basic_qos</code><span class="sig-paren">(</span><em>callback=None</em>, <em>prefetch_size=0</em>, <em>prefetch_count=0</em>, <em>all_channels=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.basic_qos" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify quality of service. This method requests a specific quality
of service. The QoS can be specified for the current channel or for all
channels on the connection. The client can request that messages be sent
in advance so that when the client finishes processing a message, the
following message is already held locally, rather than needing to be
sent down the channel. Prefetching gives a performance improvement.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call for Basic.QosOk response</li>
<li><strong>prefetch_size</strong> (<em>int</em>) – This field specifies the prefetch window
size. The server will send a message in
advance if it is equal to or smaller in size
than the available prefetch size (and also
falls into other prefetch limits). May be set
to zero, meaning “no specific limit”,
although other prefetch limits may still
apply. The prefetch-size is ignored if the
no-ack option is set.</li>
<li><strong>prefetch_count</strong> (<em>int</em>) – Specifies a prefetch window in terms of whole
messages. This field may be used in
combination with the prefetch-size field; a
message will only be sent in advance if both
prefetch windows (and those at the channel
and connection level) allow it. The
prefetch-count is ignored if the no-ack
option is set.</li>
<li><strong>all_channels</strong> (<em>bool</em>) – Should the QoS apply to all channels</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.basic_recover">
<code class="descname">basic_recover</code><span class="sig-paren">(</span><em>callback=None</em>, <em>requeue=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.basic_recover" title="Permalink to this definition">¶</a></dt>
<dd><p>This method asks the server to redeliver all unacknowledged messages
on a specified channel. Zero or more messages may be redelivered. This
method replaces the asynchronous Recover.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – Callback to call when receiving
Basic.RecoverOk</li>
<li><strong>requeue</strong> (<em>bool</em>) – If False, the message will be redelivered to the
original recipient. If True, the server will
attempt to requeue the message, potentially then
delivering it to an alternative subscriber.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.basic_reject">
<code class="descname">basic_reject</code><span class="sig-paren">(</span><em>delivery_tag</em>, <em>requeue=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.basic_reject" title="Permalink to this definition">¶</a></dt>
<dd><p>Reject an incoming message. This method allows a client to reject a
message. It can be used to interrupt and cancel large incoming messages,
or return untreatable messages to their original queue.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>delivery-tag</strong> (<em>integer</em>) – int/long The server-assigned delivery tag</li>
<li><strong>requeue</strong> (<em>bool</em>) – If requeue is true, the server will attempt to
requeue the message. If requeue is false or the
requeue attempt fails the messages are discarded or
dead-lettered.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">TypeError</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.close">
<code class="descname">close</code><span class="sig-paren">(</span><em>reply_code=0</em>, <em>reply_text='Normal shutdown'</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Invoke a graceful shutdown of the channel with the AMQP Broker.</p>
<p>If channel is OPENING, transition to CLOSING and suppress the incoming
Channel.OpenOk, if any.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>reply_code</strong> (<em>int</em>) – The reason code to send to broker</li>
<li><strong>reply_text</strong> (<em>str</em>) – The reason text to send to broker</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="exceptions.html#pika.exceptions.ChannelClosed" title="pika.exceptions.ChannelClosed"><strong>ChannelClosed</strong></a> – if channel is already closed</li>
<li><a class="reference internal" href="exceptions.html#pika.exceptions.ChannelAlreadyClosing" title="pika.exceptions.ChannelAlreadyClosing"><strong>ChannelAlreadyClosing</strong></a> – if channel is already closing</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.confirm_delivery">
<code class="descname">confirm_delivery</code><span class="sig-paren">(</span><em>callback=None</em>, <em>nowait=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.confirm_delivery" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn on Confirm mode in the channel. Pass in a callback to be
notified by the Broker when a message has been confirmed as received or
rejected (Basic.Ack, Basic.Nack) from the broker to the publisher.</p>
<dl class="docutils">
<dt>For more information see:</dt>
<dd><a class="reference external" href="http://www.rabbitmq.com/extensions.html#confirms">http://www.rabbitmq.com/extensions.html#confirms</a></dd>
</dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback for delivery confirmations that
has the following signature: callback(pika.frame.Method), where
method_frame contains either method <cite>spec.Basic.Ack</cite> or
<cite>spec.Basic.Nack</cite>.</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not send a reply frame (Confirm.SelectOk)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pika.channel.Channel.consumer_tags">
<code class="descname">consumer_tags</code><a class="headerlink" href="#pika.channel.Channel.consumer_tags" title="Permalink to this definition">¶</a></dt>
<dd><p>Property method that returns a list of currently active consumers</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.exchange_bind">
<code class="descname">exchange_bind</code><span class="sig-paren">(</span><em>callback=None</em>, <em>destination=None</em>, <em>source=None</em>, <em>routing_key=''</em>, <em>nowait=False</em>, <em>arguments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.exchange_bind" title="Permalink to this definition">¶</a></dt>
<dd><p>Bind an exchange to another exchange.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call on Exchange.BindOk; MUST
be None when nowait=True</li>
<li><strong>destination</strong> (<em>str</em><em> or </em><em>unicode</em>) – The destination exchange to bind</li>
<li><strong>source</strong> (<em>str</em><em> or </em><em>unicode</em>) – The source exchange to bind to</li>
<li><strong>routing_key</strong> (<em>str</em><em> or </em><em>unicode</em>) – The routing key to bind on</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not wait for an Exchange.BindOk</li>
<li><strong>arguments</strong> (<em>dict</em>) – Custom key/value pair arguments for the binding</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.exchange_declare">
<code class="descname">exchange_declare</code><span class="sig-paren">(</span><em>callback=None</em>, <em>exchange=None</em>, <em>exchange_type='direct'</em>, <em>passive=False</em>, <em>durable=False</em>, <em>auto_delete=False</em>, <em>internal=False</em>, <em>nowait=False</em>, <em>arguments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.exchange_declare" title="Permalink to this definition">¶</a></dt>
<dd><p>This method creates an exchange if it does not already exist, and if
the exchange exists, verifies that it is of the correct and expected
class.</p>
<p>If passive set, the server will reply with Declare-Ok if the exchange
already exists with the same name, and raise an error if not and if the
exchange does not already exist, the server MUST raise a channel
exception with reply code 404 (not found).</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – Call this method on Exchange.DeclareOk; MUST
be None when nowait=True</li>
<li><strong>exchange</strong> (<em>str</em><em> or </em><em>unicode
sequence of these characters: letters</em><em>,
</em><em>digits</em><em>, </em><em>hyphen</em><em>, </em><em>underscore</em><em>, </em><em>period</em><em>, or
</em><em>colon.</em>) – The exchange name consists of a non-empty</li>
<li><strong>exchange_type</strong> (<em>str</em>) – The exchange type to use</li>
<li><strong>passive</strong> (<em>bool</em>) – Perform a declare or just check to see if it exists</li>
<li><strong>durable</strong> (<em>bool</em>) – Survive a reboot of RabbitMQ</li>
<li><strong>auto_delete</strong> (<em>bool</em>) – Remove when no more queues are bound to it</li>
<li><strong>internal</strong> (<em>bool</em>) – Can only be published to by other exchanges</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not expect an Exchange.DeclareOk response</li>
<li><strong>arguments</strong> (<em>dict</em>) – Custom key/value pair arguments for the exchange</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.exchange_delete">
<code class="descname">exchange_delete</code><span class="sig-paren">(</span><em>callback=None</em>, <em>exchange=None</em>, <em>if_unused=False</em>, <em>nowait=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.exchange_delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete the exchange.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The function to call on Exchange.DeleteOk;
MUST be None when nowait=True.</li>
<li><strong>exchange</strong> (<em>str</em><em> or </em><em>unicode</em>) – The exchange name</li>
<li><strong>if_unused</strong> (<em>bool</em>) – only delete if the exchange is unused</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not wait for an Exchange.DeleteOk</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.exchange_unbind">
<code class="descname">exchange_unbind</code><span class="sig-paren">(</span><em>callback=None</em>, <em>destination=None</em>, <em>source=None</em>, <em>routing_key=''</em>, <em>nowait=False</em>, <em>arguments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.exchange_unbind" title="Permalink to this definition">¶</a></dt>
<dd><p>Unbind an exchange from another exchange.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call on Exchange.UnbindOk;
MUST be None when nowait=True.</li>
<li><strong>destination</strong> (<em>str</em><em> or </em><em>unicode</em>) – The destination exchange to unbind</li>
<li><strong>source</strong> (<em>str</em><em> or </em><em>unicode</em>) – The source exchange to unbind from</li>
<li><strong>routing_key</strong> (<em>str</em><em> or </em><em>unicode</em>) – The routing key to unbind</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not wait for an Exchange.UnbindOk</li>
<li><strong>arguments</strong> (<em>dict</em>) – Custom key/value pair arguments for the binding</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.flow">
<code class="descname">flow</code><span class="sig-paren">(</span><em>callback</em>, <em>active</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.flow" title="Permalink to this definition">¶</a></dt>
<dd><p>Turn Channel flow control off and on. Pass a callback to be notified
of the response from the server. active is a bool. Callback should
expect a bool in response indicating channel flow state. For more
information, please reference:</p>
<p><a class="reference external" href="http://www.rabbitmq.com/amqp-0-9-1-reference.html#channel.flow">http://www.rabbitmq.com/amqp-0-9-1-reference.html#channel.flow</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call upon completion</li>
<li><strong>active</strong> (<em>bool</em>) – Turn flow on or off</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pika.channel.Channel.is_closed">
<code class="descname">is_closed</code><a class="headerlink" href="#pika.channel.Channel.is_closed" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the channel is closed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pika.channel.Channel.is_closing">
<code class="descname">is_closing</code><a class="headerlink" href="#pika.channel.Channel.is_closing" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if client-initiated closing of the channel is in
progress.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="pika.channel.Channel.is_open">
<code class="descname">is_open</code><a class="headerlink" href="#pika.channel.Channel.is_open" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the channel is open.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.open">
<code class="descname">open</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.open" title="Permalink to this definition">¶</a></dt>
<dd><p>Open the channel</p>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.queue_bind">
<code class="descname">queue_bind</code><span class="sig-paren">(</span><em>callback</em>, <em>queue</em>, <em>exchange</em>, <em>routing_key=None</em>, <em>nowait=False</em>, <em>arguments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.queue_bind" title="Permalink to this definition">¶</a></dt>
<dd><p>Bind the queue to the specified exchange</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call on Queue.BindOk;
MUST be None when nowait=True.</li>
<li><strong>queue</strong> (<em>str</em><em> or </em><em>unicode</em>) – The queue to bind to the exchange</li>
<li><strong>exchange</strong> (<em>str</em><em> or </em><em>unicode</em>) – The source exchange to bind to</li>
<li><strong>routing_key</strong> (<em>str</em><em> or </em><em>unicode</em>) – The routing key to bind on</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not wait for a Queue.BindOk</li>
<li><strong>arguments</strong> (<em>dict</em>) – Custom key/value pair arguments for the binding</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.queue_declare">
<code class="descname">queue_declare</code><span class="sig-paren">(</span><em>callback</em>, <em>queue=''</em>, <em>passive=False</em>, <em>durable=False</em>, <em>exclusive=False</em>, <em>auto_delete=False</em>, <em>nowait=False</em>, <em>arguments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.queue_declare" title="Permalink to this definition">¶</a></dt>
<dd><p>Declare queue, create if needed. This method creates or checks a
queue. When creating a new queue the client can specify various
properties that control the durability of the queue and its contents,
and the level of sharing for the queue.</p>
<p>Leave the queue name empty for a auto-named queue in RabbitMQ</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – callback(pika.frame.Method) for method
Queue.DeclareOk; MUST be None when nowait=True.</li>
<li><strong>queue</strong> (<em>str</em><em> or </em><em>unicode</em>) – The queue name</li>
<li><strong>passive</strong> (<em>bool</em>) – Only check to see if the queue exists</li>
<li><strong>durable</strong> (<em>bool</em>) – Survive reboots of the broker</li>
<li><strong>exclusive</strong> (<em>bool</em>) – Only allow access by the current connection</li>
<li><strong>auto_delete</strong> (<em>bool</em>) – Delete after consumer cancels or disconnects</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not wait for a Queue.DeclareOk</li>
<li><strong>arguments</strong> (<em>dict</em>) – Custom key/value arguments for the queue</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.queue_delete">
<code class="descname">queue_delete</code><span class="sig-paren">(</span><em>callback=None</em>, <em>queue=''</em>, <em>if_unused=False</em>, <em>if_empty=False</em>, <em>nowait=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.queue_delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a queue from the broker.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call on Queue.DeleteOk;
MUST be None when nowait=True.</li>
<li><strong>queue</strong> (<em>str</em><em> or </em><em>unicode</em>) – The queue to delete</li>
<li><strong>if_unused</strong> (<em>bool</em>) – only delete if it’s unused</li>
<li><strong>if_empty</strong> (<em>bool</em>) – only delete if the queue is empty</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not wait for a Queue.DeleteOk</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.queue_purge">
<code class="descname">queue_purge</code><span class="sig-paren">(</span><em>callback=None</em>, <em>queue=''</em>, <em>nowait=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.queue_purge" title="Permalink to this definition">¶</a></dt>
<dd><p>Purge all of the messages from the specified queue</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call on Queue.PurgeOk;
MUST be None when nowait=True.</li>
<li><strong>queue</strong> (<em>str</em><em> or </em><em>unicode</em>) – The queue to purge</li>
<li><strong>nowait</strong> (<em>bool</em>) – Do not expect a Queue.PurgeOk response</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.queue_unbind">
<code class="descname">queue_unbind</code><span class="sig-paren">(</span><em>callback=None</em>, <em>queue=''</em>, <em>exchange=None</em>, <em>routing_key=None</em>, <em>arguments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.queue_unbind" title="Permalink to this definition">¶</a></dt>
<dd><p>Unbind a queue from an exchange.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>callback</strong> (<em>callable</em>) – The callback to call on Queue.UnbindOk</li>
<li><strong>queue</strong> (<em>str</em><em> or </em><em>unicode</em>) – The queue to unbind from the exchange</li>
<li><strong>exchange</strong> (<em>str</em><em> or </em><em>unicode</em>) – The source exchange to bind from</li>
<li><strong>routing_key</strong> (<em>str</em><em> or </em><em>unicode</em>) – The routing key to unbind</li>
<li><strong>arguments</strong> (<em>dict</em>) – Custom key/value pair arguments for the binding</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.tx_commit">
<code class="descname">tx_commit</code><span class="sig-paren">(</span><em>callback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.tx_commit" title="Permalink to this definition">¶</a></dt>
<dd><p>Commit a transaction</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> (<em>callable</em>) – The callback for delivery confirmations</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.tx_rollback">
<code class="descname">tx_rollback</code><span class="sig-paren">(</span><em>callback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.tx_rollback" title="Permalink to this definition">¶</a></dt>
<dd><p>Rollback a transaction.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> (<em>callable</em>) – The callback for delivery confirmations</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="pika.channel.Channel.tx_select">
<code class="descname">tx_select</code><span class="sig-paren">(</span><em>callback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pika.channel.Channel.tx_select" title="Permalink to this definition">¶</a></dt>
<dd><p>Select standard transaction mode. This method sets the channel to use
standard transactions. The client must use this method at least once on
a channel before using the Commit or Rollback methods.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> (<em>callable</em>) – The callback for delivery confirmations</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Channel</a><ul>
<li><a class="reference internal" href="#id1">Channel</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="adapters/twisted.html"
title="previous chapter">Twisted Connection Adapter</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="connection.html"
title="next chapter">Connection</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/modules/channel.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="connection.html" title="Connection"
>next</a> |</li>
<li class="right" >
<a href="adapters/twisted.html" title="Twisted Connection Adapter"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pika 0.11.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >Core Class and Module Documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2017, Tony Garnock-Jones, Gavin M. Roy, Pivotal and others..
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
</div>
</body>
</html>
|