-
Notifications
You must be signed in to change notification settings - Fork 840
/
channel.py
1515 lines (1214 loc) · 61.6 KB
/
channel.py
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
"""The Channel class provides a wrapper for interacting with RabbitMQ
implementing the methods and behaviors for an AMQP Channel.
"""
# disable too-many-lines
# pylint: disable=C0302
import collections
import logging
import uuid
from enum import Enum
import pika.frame as frame
import pika.exceptions as exceptions
import pika.spec as spec
import pika.validators as validators
from pika.compat import unicode_type, dictkeys, is_integer
from pika.exchange_type import ExchangeType
LOGGER = logging.getLogger(__name__)
MAX_CHANNELS = 65535 # per AMQP 0.9.1 spec.
class Channel:
"""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 a channel by
calling the active connection's channel() method.
"""
# Disable pylint messages concerning "method could be a function"
# pylint: disable=R0201
CLOSED = 0
OPENING = 1
OPEN = 2
CLOSING = 3 # client-initiated close in progress
_STATE_NAMES = {
CLOSED: 'CLOSED',
OPENING: 'OPENING',
OPEN: 'OPEN',
CLOSING: 'CLOSING'
}
_ON_CHANNEL_CLEANUP_CB_KEY = '_on_channel_cleanup'
def __init__(self, connection, channel_number, on_open_callback):
"""Create a new instance of the Channel
:param pika.connection.Connection connection: The connection
:param int channel_number: The channel number for this instance
:param callable on_open_callback: The callback to call on channel open.
The callback will be invoked with the `Channel` instance as its only
argument.
"""
if not isinstance(channel_number, int):
raise exceptions.InvalidChannelNumber(channel_number)
validators.rpc_completion_callback(on_open_callback)
self.channel_number = channel_number
self.callbacks = connection.callbacks
self.connection = connection
# Initially, flow is assumed to be active
self.flow_active = True
self._content_assembler = ContentFrameAssembler()
self._blocked = collections.deque(list())
self._blocking = None
self._has_on_flow_callback = False
self._cancelled = set()
self._consumers = dict()
self._consumers_with_noack = set()
self._on_flowok_callback = None
self._on_getok_callback = None
self._on_openok_callback = on_open_callback
self._state = self.CLOSED
# We save the closing reason exception to be passed to on-channel-close
# callback at closing of the channel. Exception representing the closing
# reason; ChannelClosedByClient or ChannelClosedByBroker on controlled
# close; otherwise another exception describing the reason for failure
# (most likely connection failure).
self._closing_reason = None # type: None | Exception
# opaque cookie value set by wrapper layer (e.g., BlockingConnection)
# via _set_cookie
self._cookie = None
def __int__(self):
"""Return the channel object as its channel number
:rtype: int
"""
return self.channel_number
def __repr__(self):
return '<{} number={} {} conn={!r}>'.format(
self.__class__.__name__, self.channel_number,
self._STATE_NAMES[self._state], self.connection)
def add_callback(self, callback, replies, one_shot=True):
"""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.
:param callable callback: The callback to call
:param list replies: The replies to get a callback for
:param bool one_shot: Only handle the first type callback
"""
for reply in replies:
self.callbacks.add(self.channel_number, reply, callback, one_shot)
def add_on_cancel_callback(self, callback):
"""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.
:param callable callback: The callback to call on Basic.Cancel from
broker
"""
self.callbacks.add(self.channel_number, spec.Basic.Cancel, callback,
False)
def add_on_close_callback(self, callback):
"""Pass a callback function that will be called when the channel is
closed. The callback function will receive the channel and an exception
describing why the channel was closed.
If the channel is closed by broker via Channel.Close, the callback will
receive `ChannelClosedByBroker` as the reason.
If graceful user-initiated channel closing completes successfully (
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
`ChannelClosedByClient` exception as reason.
If channel was closed due to loss of connection, the callback will
receive another exception type describing the failure.
:param callable callback: The callback, having the signature:
callback(Channel, Exception reason)
"""
self.callbacks.add(self.channel_number, '_on_channel_close', callback,
False, self)
def add_on_flow_callback(self, callback):
"""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
:param callable callback: The callback function
"""
self._has_on_flow_callback = True
self.callbacks.add(self.channel_number, spec.Channel.Flow, callback,
False)
def add_on_return_callback(self, callback):
"""Pass a callback function that will be called when basic_publish is
sent a message that has been rejected and returned by the server.
:param callable callback: The function to call, having the signature
callback(channel, method, properties, body)
where
- channel: pika.channel.Channel
- method: pika.spec.Basic.Return
- properties: pika.spec.BasicProperties
- body: bytes
"""
self.callbacks.add(self.channel_number, '_on_return', callback, False)
def basic_ack(self, delivery_tag=0, multiple=False):
"""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.
:param integer delivery_tag: int/long The server-assigned delivery tag
:param bool multiple: 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.
"""
self._raise_if_not_open()
return self._send_method(spec.Basic.Ack(delivery_tag, multiple))
def basic_cancel(self, consumer_tag='', callback=None):
"""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.
:param str consumer_tag: Identifier for the consumer
:param callable callback: callback(pika.frame.Method) for method
Basic.CancelOk. If None, do not expect a Basic.CancelOk response,
otherwise, callback must be callable
:raises ValueError:
"""
validators.require_string(consumer_tag, 'consumer_tag')
self._raise_if_not_open()
nowait = validators.rpc_completion_callback(callback)
if consumer_tag in self._cancelled:
# We check for cancelled first, because basic_cancel removes
# consumers closed with nowait from self._consumers
LOGGER.warning('basic_cancel - consumer is already cancelling: %s',
consumer_tag)
return
if consumer_tag not in self._consumers:
# Could be cancelled by user or broker earlier
LOGGER.warning('basic_cancel - consumer not found: %s',
consumer_tag)
return
LOGGER.debug('Cancelling consumer: %s (nowait=%s)', consumer_tag,
nowait)
if nowait:
# This is our last opportunity while the channel is open to remove
# this consumer callback and help gc; unfortunately, this consumer's
# self._cancelled and self._consumers_with_noack (if any) entries
# will persist until the channel is closed.
del self._consumers[consumer_tag]
if callback is not None:
self.callbacks.add(self.channel_number, spec.Basic.CancelOk,
callback)
self._cancelled.add(consumer_tag)
self._rpc(spec.Basic.Cancel(consumer_tag=consumer_tag, nowait=nowait),
self._on_cancelok if not nowait else None,
[(spec.Basic.CancelOk, {
'consumer_tag': consumer_tag
})] if not nowait else [])
def basic_consume(self,
queue,
on_message_callback,
auto_ack=False,
exclusive=False,
consumer_tag=None,
arguments=None,
callback=None):
"""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.
For more information on basic_consume, see:
Tutorial 2 at http://www.rabbitmq.com/getstarted.html
http://www.rabbitmq.com/confirms.html
http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.consume
:param str queue: The queue to consume from. Use the empty string to
specify the most recent server-named queue for this channel
:param callable on_message_callback: The function to call when
consuming with the signature
on_message_callback(channel, method, properties, body), where
- channel: pika.channel.Channel
- method: pika.spec.Basic.Deliver
- properties: pika.spec.BasicProperties
- body: bytes
:param bool auto_ack: if set to True, automatic acknowledgement mode
will be used (see http://www.rabbitmq.com/confirms.html).
This corresponds with the 'no_ack' parameter in the basic.consume
AMQP 0.9.1 method
:param bool exclusive: Don't allow other consumers on the queue
:param str consumer_tag: Specify your own consumer tag
:param dict arguments: Custom key/value pair arguments for the consumer
:param callable callback: callback(pika.frame.Method) for method
Basic.ConsumeOk.
:returns: Consumer tag which may be used to cancel the consumer.
:rtype: str
:raises ValueError:
"""
validators.require_string(queue, 'queue')
validators.require_callback(on_message_callback)
self._raise_if_not_open()
validators.rpc_completion_callback(callback)
# If a consumer tag was not passed, create one
if not consumer_tag:
consumer_tag = self._generate_consumer_tag()
if consumer_tag in self._consumers or consumer_tag in self._cancelled:
raise exceptions.DuplicateConsumerTag(consumer_tag)
if auto_ack:
self._consumers_with_noack.add(consumer_tag)
self._consumers[consumer_tag] = on_message_callback
rpc_callback = self._on_eventok if callback is None else callback
self._rpc(
spec.Basic.Consume(queue=queue,
consumer_tag=consumer_tag,
no_ack=auto_ack,
exclusive=exclusive,
arguments=arguments or dict()), rpc_callback,
[(spec.Basic.ConsumeOk, {
'consumer_tag': consumer_tag
})])
return consumer_tag
def _generate_consumer_tag(self):
"""Generate a consumer tag
NOTE: this protected method may be called by derived classes
:returns: consumer tag
:rtype: str
"""
return 'ctag%i.%s' % (self.channel_number, uuid.uuid4().hex)
def basic_get(self, queue, callback, auto_ack=False):
"""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:
http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.get
:param str queue: The queue from which to get a message. Use the empty
string to specify the most recent server-named queue for this
channel
:param callable callback: The callback to call with a message that has
the signature callback(channel, method, properties, body), where:
- channel: pika.channel.Channel
- method: pika.spec.Basic.GetOk
- properties: pika.spec.BasicProperties
- body: bytes
:param bool auto_ack: Tell the broker to not expect a reply
:raises ValueError:
"""
validators.require_string(queue, 'queue')
validators.require_callback(callback)
if self._on_getok_callback is not None:
raise exceptions.DuplicateGetOkCallback()
self._on_getok_callback = callback
# pylint: disable=W0511
# TODO Strangely, not using _rpc for the synchronous Basic.Get. Would
# need to extend _rpc to handle Basic.GetOk method, header, and body
# frames (or similar)
self._send_method(spec.Basic.Get(queue=queue, no_ack=auto_ack))
def basic_nack(self, delivery_tag=0, multiple=False, requeue=True):
"""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.
:param integer delivery_tag: int/long The server-assigned delivery tag
:param bool multiple: 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.
:param bool requeue: 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.
"""
self._raise_if_not_open()
return self._send_method(
spec.Basic.Nack(delivery_tag, multiple, requeue))
def basic_publish(self,
exchange,
routing_key,
body,
properties=None,
mandatory=False):
"""Publish to the channel with the given exchange, routing key and body.
For more information on basic_publish and what the parameters do, see:
http://www.rabbitmq.com/amqp-0-9-1-reference.html#basic.publish
:param str exchange: The exchange to publish to
:param str routing_key: The routing key to bind on
:param bytes body: The message body
:param pika.spec.BasicProperties properties: Basic.properties
:param bool mandatory: The mandatory flag
"""
self._raise_if_not_open()
if isinstance(body, unicode_type):
body = body.encode('utf-8')
properties = properties or spec.BasicProperties()
self._send_method(
spec.Basic.Publish(exchange=exchange,
routing_key=routing_key,
mandatory=mandatory), (properties, body))
def basic_qos(self,
prefetch_size=0,
prefetch_count=0,
global_qos=False,
callback=None):
"""Specify quality of service. This method requests a specific quality
of service. 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. The QoS can be applied separately to each new consumer on
channel or shared across all consumers on the channel. Prefetching
gives a performance improvement.
:param int prefetch_size: 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 by
consumers who have enabled the no-ack option.
:param int prefetch_count: 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 by consumers who
have enabled the no-ack option.
:param bool global_qos: Should the QoS be shared across all
consumers on the channel.
:param callable callback: The callback to call for Basic.QosOk response
:raises ValueError:
"""
self._raise_if_not_open()
validators.rpc_completion_callback(callback)
validators.zero_or_greater('prefetch_size', prefetch_size)
validators.zero_or_greater('prefetch_count', prefetch_count)
return self._rpc(
spec.Basic.Qos(prefetch_size, prefetch_count, global_qos), callback,
[spec.Basic.QosOk])
def basic_reject(self, delivery_tag=0, requeue=True):
"""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.
:param integer delivery_tag: int/long The server-assigned delivery tag
:param bool requeue: 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.
:raises: TypeError
"""
self._raise_if_not_open()
if not is_integer(delivery_tag):
raise TypeError('delivery_tag must be an integer')
return self._send_method(spec.Basic.Reject(delivery_tag, requeue))
def basic_recover(self, requeue=False, callback=None):
"""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.
:param bool requeue: 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.
:param callable callback: Callback to call when receiving
Basic.RecoverOk
:param callable callback: callback(pika.frame.Method) for method
Basic.RecoverOk
:raises ValueError:
"""
self._raise_if_not_open()
validators.rpc_completion_callback(callback)
return self._rpc(spec.Basic.Recover(requeue), callback,
[spec.Basic.RecoverOk])
def close(self, reply_code=0, reply_text="Normal shutdown"):
"""Invoke a graceful shutdown of the channel with the AMQP Broker.
If channel is OPENING, transition to CLOSING and suppress the incoming
Channel.OpenOk, if any.
:param int reply_code: The reason code to send to broker
:param str reply_text: The reason text to send to broker
:raises ChannelWrongStateError: if channel is closed or closing
"""
if self.is_closed or self.is_closing:
# Whoever is calling `close` might expect the on-channel-close-cb
# to be called, which won't happen when it's already closed.
self._raise_if_not_open()
# If channel is OPENING, we will transition it to CLOSING state,
# causing the _on_openok method to suppress the OPEN state transition
# and the on-channel-open-callback
LOGGER.info('Closing channel (%s): %r on %s', reply_code, reply_text,
self)
# Save the reason info so that we may use it in the '_on_channel_close'
# callback processing
self._closing_reason = exceptions.ChannelClosedByClient(
reply_code, reply_text)
for consumer_tag in dictkeys(self._consumers):
if consumer_tag not in self._cancelled:
self.basic_cancel(consumer_tag=consumer_tag)
# Change state after cancelling consumers to avoid
# ChannelWrongStateError exception from basic_cancel
self._set_state(self.CLOSING)
self._rpc(spec.Channel.Close(reply_code, reply_text, 0, 0),
self._on_closeok, [spec.Channel.CloseOk])
def confirm_delivery(self, ack_nack_callback, callback=None):
"""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.
For more information see:
https://www.rabbitmq.com/confirms.html
:param callable ack_nack_callback: Required callback for delivery
confirmations that has the following signature:
callback(pika.frame.Method), where method_frame contains
either method `spec.Basic.Ack` or `spec.Basic.Nack`.
:param callable callback: callback(pika.frame.Method) for method
Confirm.SelectOk
:raises ValueError:
"""
if not callable(ack_nack_callback):
# confirm_deliver requires a callback; it's meaningless
# without a user callback to receieve Basic.Ack/Basic.Nack notifications
raise ValueError('confirm_delivery requires a callback '
'to receieve Basic.Ack/Basic.Nack notifications')
self._raise_if_not_open()
nowait = validators.rpc_completion_callback(callback)
if not (self.connection.publisher_confirms and
self.connection.basic_nack):
raise exceptions.MethodNotImplemented(
'Confirm.Select not Supported by Server')
# Add the ack and nack callback
self.callbacks.add(self.channel_number, spec.Basic.Ack,
ack_nack_callback, False)
self.callbacks.add(self.channel_number, spec.Basic.Nack,
ack_nack_callback, False)
self._rpc(spec.Confirm.Select(nowait), callback,
[spec.Confirm.SelectOk] if not nowait else [])
@property
def consumer_tags(self):
"""Property method that returns a list of currently active consumers
:rtype: list
"""
return dictkeys(self._consumers)
def exchange_bind(self,
destination,
source,
routing_key='',
arguments=None,
callback=None):
"""Bind an exchange to another exchange.
:param str destination: The destination exchange to bind
:param str source: The source exchange to bind to
:param str routing_key: The routing key to bind on
:param dict arguments: Custom key/value pair arguments for the binding
:param callable callback: callback(pika.frame.Method) for method Exchange.BindOk
:raises ValueError:
"""
self._raise_if_not_open()
validators.require_string(destination, 'destination')
validators.require_string(source, 'source')
nowait = validators.rpc_completion_callback(callback)
return self._rpc(
spec.Exchange.Bind(0, destination, source, routing_key, nowait,
arguments or dict()), callback,
[spec.Exchange.BindOk] if not nowait else [])
def exchange_declare(self,
exchange,
exchange_type=ExchangeType.direct,
passive=False,
durable=False,
auto_delete=False,
internal=False,
arguments=None,
callback=None):
"""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.
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).
:param str exchange: The exchange name consists of a non-empty sequence
of these characters: letters, digits, hyphen, underscore, period,
or colon
:param str exchange_type: The exchange type to use
:param bool passive: Perform a declare or just check to see if it exists
:param bool durable: Survive a reboot of RabbitMQ
:param bool auto_delete: Remove when no more queues are bound to it
:param bool internal: Can only be published to by other exchanges
:param dict arguments: Custom key/value pair arguments for the exchange
:param callable callback: callback(pika.frame.Method) for method Exchange.DeclareOk
:raises ValueError:
"""
validators.require_string(exchange, 'exchange')
self._raise_if_not_open()
nowait = validators.rpc_completion_callback(callback)
if isinstance(exchange_type, Enum):
exchange_type = exchange_type.value
return self._rpc(
spec.Exchange.Declare(0, exchange, exchange_type, passive, durable,
auto_delete, internal, nowait, arguments or
dict()), callback,
[spec.Exchange.DeclareOk] if not nowait else [])
def exchange_delete(self, exchange=None, if_unused=False, callback=None):
"""Delete the exchange.
:param str exchange: The exchange name
:param bool if_unused: only delete if the exchange is unused
:param callable callback: callback(pika.frame.Method) for method Exchange.DeleteOk
:raises ValueError:
"""
self._raise_if_not_open()
nowait = validators.rpc_completion_callback(callback)
return self._rpc(spec.Exchange.Delete(0, exchange, if_unused,
nowait), callback,
[spec.Exchange.DeleteOk] if not nowait else [])
def exchange_unbind(self,
destination=None,
source=None,
routing_key='',
arguments=None,
callback=None):
"""Unbind an exchange from another exchange.
:param str destination: The destination exchange to unbind
:param str source: The source exchange to unbind from
:param str routing_key: The routing key to unbind
:param dict arguments: Custom key/value pair arguments for the binding
:param callable callback: callback(pika.frame.Method) for method Exchange.UnbindOk
:raises ValueError:
"""
self._raise_if_not_open()
nowait = validators.rpc_completion_callback(callback)
return self._rpc(
spec.Exchange.Unbind(0, destination, source, routing_key, nowait,
arguments), callback,
[spec.Exchange.UnbindOk] if not nowait else [])
def flow(self, active, callback=None):
"""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:
http://www.rabbitmq.com/amqp-0-9-1-reference.html#channel.flow
:param bool active: Turn flow on or off
:param callable callback: callback(bool) upon completion
:raises ValueError:
"""
self._raise_if_not_open()
validators.rpc_completion_callback(callback)
self._on_flowok_callback = callback
self._rpc(spec.Channel.Flow(active), self._on_flowok,
[spec.Channel.FlowOk])
@property
def is_closed(self):
"""Returns True if the channel is closed.
:rtype: bool
"""
return self._state == self.CLOSED
@property
def is_closing(self):
"""Returns True if client-initiated closing of the channel is in
progress.
:rtype: bool
"""
return self._state == self.CLOSING
@property
def is_open(self):
"""Returns True if the channel is open.
:rtype: bool
"""
return self._state == self.OPEN
@property
def is_opening(self):
"""Returns True if the channel is opening.
:rtype: bool
"""
return self._state == self.OPENING
def open(self):
"""Open the channel"""
self._set_state(self.OPENING)
self._add_callbacks()
self._rpc(spec.Channel.Open(), self._on_openok, [spec.Channel.OpenOk])
def queue_bind(self,
queue,
exchange,
routing_key=None,
arguments=None,
callback=None):
"""Bind the queue to the specified exchange
:param str queue: The queue to bind to the exchange
:param str exchange: The source exchange to bind to
:param str routing_key: The routing key to bind on
:param dict arguments: Custom key/value pair arguments for the binding
:param callable callback: callback(pika.frame.Method) for method Queue.BindOk
:raises ValueError:
"""
validators.require_string(queue, 'queue')
validators.require_string(exchange, 'exchange')
self._raise_if_not_open()
nowait = validators.rpc_completion_callback(callback)
if routing_key is None:
routing_key = queue
return self._rpc(
spec.Queue.Bind(0, queue, exchange, routing_key, nowait,
arguments or dict()), callback,
[spec.Queue.BindOk] if not nowait else [])
def queue_declare(self,
queue,
passive=False,
durable=False,
exclusive=False,
auto_delete=False,
arguments=None,
callback=None):
"""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.
Use an empty string as the queue name for the broker to auto-generate
one
:param str queue: The queue name; if empty string, the broker will
create a unique queue name
:param bool passive: Only check to see if the queue exists
:param bool durable: Survive reboots of the broker
:param bool exclusive: Only allow access by the current connection
:param bool auto_delete: Delete after consumer cancels or disconnects
:param dict arguments: Custom key/value arguments for the queue
:param callable callback: callback(pika.frame.Method) for method Queue.DeclareOk
:raises ValueError:
"""
validators.require_string(queue, 'queue')
self._raise_if_not_open()
nowait = validators.rpc_completion_callback(callback)
if queue:
condition = (spec.Queue.DeclareOk, {'queue': queue})
else:
condition = spec.Queue.DeclareOk
replies = [condition] if not nowait else []
return self._rpc(
spec.Queue.Declare(0, queue, passive, durable, exclusive,
auto_delete, nowait, arguments or dict()),
callback, replies)
def queue_delete(self,
queue,
if_unused=False,
if_empty=False,
callback=None):
"""Delete a queue from the broker.
:param str queue: The queue to delete
:param bool if_unused: only delete if it's unused
:param bool if_empty: only delete if the queue is empty
:param callable callback: callback(pika.frame.Method) for method Queue.DeleteOk
:raises ValueError:
"""
self._raise_if_not_open()
validators.require_string(queue, 'queue')
nowait = validators.rpc_completion_callback(callback)
replies = [spec.Queue.DeleteOk] if not nowait else []
return self._rpc(
spec.Queue.Delete(0, queue, if_unused, if_empty, nowait), callback,
replies)
def queue_purge(self, queue, callback=None):
"""Purge all of the messages from the specified queue
:param str queue: The queue to purge
:param callable callback: callback(pika.frame.Method) for method Queue.PurgeOk
:raises ValueError:
"""
self._raise_if_not_open()
validators.require_string(queue, 'queue')
nowait = validators.rpc_completion_callback(callback)
replies = [spec.Queue.PurgeOk] if not nowait else []
return self._rpc(spec.Queue.Purge(0, queue, nowait), callback, replies)
def queue_unbind(self,
queue,
exchange=None,
routing_key=None,
arguments=None,
callback=None):
"""Unbind a queue from an exchange.
:param str queue: The queue to unbind from the exchange
:param str exchange: The source exchange to bind from
:param str routing_key: The routing key to unbind
:param dict arguments: Custom key/value pair arguments for the binding
:param callable callback: callback(pika.frame.Method) for method Queue.UnbindOk
:raises ValueError:
"""
self._raise_if_not_open()
validators.require_string(queue, 'queue')
validators.rpc_completion_callback(callback)
if routing_key is None:
routing_key = queue
return self._rpc(
spec.Queue.Unbind(0, queue, exchange, routing_key, arguments or
dict()), callback, [spec.Queue.UnbindOk])
def tx_commit(self, callback=None):
"""Commit a transaction
:param callable callback: The callback for delivery confirmations
:raises ValueError:
"""
self._raise_if_not_open()
validators.rpc_completion_callback(callback)
return self._rpc(spec.Tx.Commit(), callback, [spec.Tx.CommitOk])
def tx_rollback(self, callback=None):
"""Rollback a transaction.
:param callable callback: The callback for delivery confirmations
:raises ValueError:
"""
self._raise_if_not_open()
validators.rpc_completion_callback(callback)
return self._rpc(spec.Tx.Rollback(), callback, [spec.Tx.RollbackOk])
def tx_select(self, callback=None):
"""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.
:param callable callback: The callback for delivery confirmations
:raises ValueError:
"""
self._raise_if_not_open()
validators.rpc_completion_callback(callback)
return self._rpc(spec.Tx.Select(), callback, [spec.Tx.SelectOk])
# Internal methods
def _add_callbacks(self):
"""Callbacks that add the required behavior for a channel when
connecting and connected to a server.
"""
# Add a callback for Basic.GetEmpty
self.callbacks.add(self.channel_number, spec.Basic.GetEmpty,
self._on_getempty, False)
# Add a callback for Basic.Cancel
self.callbacks.add(self.channel_number, spec.Basic.Cancel,
self._on_cancel, False)
# Deprecated in newer versions of RabbitMQ but still register for it
self.callbacks.add(self.channel_number, spec.Channel.Flow,
self._on_flow, False)
# Add a callback for when the server closes our channel
self.callbacks.add(self.channel_number, spec.Channel.Close,
self._on_close_from_broker, True)
def _add_on_cleanup_callback(self, callback):
"""For internal use only (e.g., Connection needs to remove closed
channels from its channel container). Pass a callback function that will
be called when the channel is being cleaned up after all channel-close
callbacks callbacks.
:param callable callback: The callback to call, having the
signature: callback(channel)
"""
self.callbacks.add(self.channel_number,
self._ON_CHANNEL_CLEANUP_CB_KEY,
callback,
one_shot=True,
only_caller=self)
def _cleanup(self):
"""Remove all consumers and any callbacks for the channel."""
self.callbacks.process(self.channel_number,
self._ON_CHANNEL_CLEANUP_CB_KEY, self, self)
self._consumers = dict()
self.callbacks.cleanup(str(self.channel_number))
self._cookie = None
def _cleanup_consumer_ref(self, consumer_tag):
"""Remove any references to the consumer tag in internal structures
for consumer state.
:param str consumer_tag: The consumer tag to cleanup
"""
self._consumers_with_noack.discard(consumer_tag)
self._consumers.pop(consumer_tag, None)
self._cancelled.discard(consumer_tag)
def _get_cookie(self):
"""Used by the wrapper implementation (e.g., `BlockingChannel`) to
retrieve the cookie that it set via `_set_cookie`
:returns: opaque cookie value that was set via `_set_cookie`
:rtype: object