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
|
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
"""
A candidate high level messaging API for python.
Areas that still need work:
- definition of the arguments for L{Session.sender} and L{Session.receiver}
- standard L{Message} properties
- L{Message} content encoding
- protocol negotiation/multiprotocol impl
"""
from codec010 import StringCodec
from concurrency import synchronized, Waiter, Condition
from datatypes import timestamp, uuid4, Serial
from logging import getLogger
from ops import PRIMITIVE
from threading import Thread, RLock
from util import default
log = getLogger("qpid.messaging")
static = staticmethod
AMQP_PORT = 5672
AMQPS_PORT = 5671
class Constant:
def __init__(self, name, value=None):
self.name = name
self.value = value
def __repr__(self):
return self.name
UNLIMITED = Constant("UNLIMITED", 0xFFFFFFFFL)
class ConnectionError(Exception):
"""
The base class for all connection related exceptions.
"""
pass
class ConnectError(ConnectionError):
"""
Exception raised when there is an error connecting to the remote
peer.
"""
pass
class Connection:
"""
A Connection manages a group of L{Sessions<Session>} and connects
them with a remote endpoint.
"""
@static
def open(host, port=None, username="guest", password="guest", **options):
"""
Creates an AMQP connection and connects it to the given host and port.
@type host: str
@param host: the name or ip address of the remote host
@type port: int
@param port: the port number of the remote host
@rtype: Connection
@return: a connected Connection
"""
conn = Connection(host, port, username, password, **options)
conn.connect()
return conn
def __init__(self, host, port=None, username="guest", password="guest", **options):
"""
Creates a connection. A newly created connection must be connected
with the Connection.connect() method before it can be used.
@type host: str
@param host: the name or ip address of the remote host
@type port: int
@param port: the port number of the remote host
@rtype: Connection
@return: a disconnected Connection
"""
self.host = host
self.port = default(port, AMQP_PORT)
self.username = username
self.password = password
self.mechanisms = options.get("mechanisms")
self.heartbeat = options.get("heartbeat")
self.options = options
self.id = str(uuid4())
self.session_counter = 0
self.sessions = {}
self.reconnect = options.get("reconnect", False)
self._connected = False
self._lock = RLock()
self._condition = Condition(self._lock)
self._waiter = Waiter(self._condition)
self._modcount = Serial(0)
self.error = None
from driver import Driver
self._driver = Driver(self)
self._driver.start()
def _wait(self, predicate, timeout=None):
return self._waiter.wait(predicate, timeout=timeout)
def _wakeup(self):
self._modcount += 1
self._driver.wakeup()
def _check_error(self, exc=ConnectionError):
if self.error:
raise exc(*self.error)
def _ewait(self, predicate, timeout=None, exc=ConnectionError):
result = self._wait(lambda: self.error or predicate(), timeout)
self._check_error(exc)
return result
@synchronized
def session(self, name=None, transactional=False):
"""
Creates or retrieves the named session. If the name is omitted or
None, then a unique name is chosen based on a randomly generated
uuid.
@type name: str
@param name: the session name
@rtype: Session
@return: the named Session
"""
if name is None:
name = "%s:%s" % (self.id, self.session_counter)
self.session_counter += 1
else:
name = "%s:%s" % (self.id, name)
if self.sessions.has_key(name):
return self.sessions[name]
else:
ssn = Session(self, name, transactional)
self.sessions[name] = ssn
self._wakeup()
return ssn
@synchronized
def _remove_session(self, ssn):
del self.sessions[ssn.name]
@synchronized
def connect(self):
"""
Connect to the remote endpoint.
"""
self._connected = True
self._wakeup()
self._ewait(lambda: self._driver._connected, exc=ConnectError)
@synchronized
def disconnect(self):
"""
Disconnect from the remote endpoint.
"""
self._connected = False
self._wakeup()
self._ewait(lambda: not self._driver._connected)
@synchronized
def connected(self):
"""
Return true if the connection is connected, false otherwise.
"""
return self._connected
@synchronized
def close(self):
"""
Close the connection and all sessions.
"""
for ssn in self.sessions.values():
ssn.close()
self.disconnect()
class Pattern:
"""
The pattern filter matches the supplied wildcard pattern against a
message subject.
"""
def __init__(self, value):
self.value = value
# XXX: this should become part of the driver
def _bind(self, sst, exchange, queue):
from qpid.ops import ExchangeBind
sst.write_cmd(ExchangeBind(exchange=exchange, queue=queue,
binding_key=self.value.replace("*", "#")))
class SessionError(Exception):
pass
class Disconnected(SessionError):
"""
Exception raised when an operation is attempted that is illegal when
disconnected.
"""
pass
class NontransactionalSession(SessionError):
"""
Exception raised when commit or rollback is attempted on a non
transactional session.
"""
pass
class TransactionAborted(SessionError):
pass
class Session:
"""
Sessions provide a linear context for sending and receiving
L{Messages<Message>}. L{Messages<Message>} are sent and received
using the L{Sender.send} and L{Receiver.fetch} methods of the
L{Sender} and L{Receiver} objects associated with a Session.
Each L{Sender} and L{Receiver} is created by supplying either a
target or source address to the L{sender} and L{receiver} methods of
the Session. The address is supplied via a string syntax documented
below.
Addresses
=========
An address identifies a source or target for messages. In its
simplest form this is just a name. In general a target address may
also be used as a source address, however not all source addresses
may be used as a target, e.g. a source might additionally have some
filtering criteria that would not be present in a target.
A subject may optionally be specified along with the name. When an
address is used as a target, any subject specified in the address is
used as the default subject of outgoing messages for that target.
When an address is used as a source, any subject specified in the
address is pattern matched against the subject of available messages
as a filter for incoming messages from that source.
The options map contains additional information about the address
including:
- policies for automatically creating, and deleting the node to
which an address refers
- policies for asserting facts about the node to which an address
refers
- extension points that can be used for sender/receiver
configuration
Mapping to AMQP 0-10
--------------------
The name is resolved to either an exchange or a queue by querying
the broker.
The subject is set as a property on the message. Additionally, if
the name refers to an exchange, the routing key is set to the
subject.
Syntax
------
The following regular expressions define the tokens used to parse
addresses::
LBRACE: \\{
RBRACE: \\}
LBRACK: \\[
RBRACK: \\]
COLON: :
SEMI: ;
SLASH: /
COMMA: ,
NUMBER: [+-]?[0-9]*\\.?[0-9]+
ID: [a-zA-Z_](?:[a-zA-Z0-9_-]*[a-zA-Z0-9_])?
STRING: "(?:[^\\\\"]|\\\\.)*"|\'(?:[^\\\\\']|\\\\.)*\'
ESC: \\\\[^ux]|\\\\x[0-9a-fA-F][0-9a-fA-F]|\\\\u[0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F]
SYM: [.#*%@$^!+-]
WSPACE: [ \\n\\r\\t]+
The formal grammar for addresses is given below::
address = name [ "/" subject ] [ ";" options ]
name = ( part | quoted )+
subject = ( part | quoted | "/" )*
quoted = STRING / ESC
part = LBRACE / RBRACE / COLON / COMMA / NUMBER / ID / SYM
options = map
map = "{" ( keyval ( "," keyval )* )? "}"
keyval = ID ":" value
value = NUMBER / STRING / ID / map / list
list = "[" ( value ( "," value )* )? "]"
This grammar resuls in the following informal syntax::
<name> [ / <subject> ] [ ; <options> ]
Where options is::
{ <key> : <value>, ... }
And values may be:
- numbers
- single, double, or non quoted strings
- maps (dictionaries)
- lists
Options
-------
The options map permits the following parameters::
<name> [ / <subject> ] {
create: <create-policy>,
delete: <delete-policy>,
assert: <assert-policy>,
node-properties: {
type: <node-type>,
durable: <node-durability>,
x-properties: {
bindings: ["<exchange>/<key>", ...],
<passthrough-key>: <passthrough-value>
}
}
}
The create, delete, and assert policies specify who should perfom
the associated action:
- I{always}: the action will always be performed
- I{sender}: the action will only be performed by the sender
- I{receiver}: the action will only be performed by the receiver
- I{never}: the action will never be performed (this is the default)
The node-type is one of:
- I{topic}: a topic node will default to the topic exchange,
x-properties may be used to specify other exchange types
- I{queue}: this is the default node-type
The x-properties map permits arbitrary additional keys and values to
be specified. These keys and values are passed through when creating
a node or asserting facts about an existing node. Any passthrough
keys and values that do not match a standard field of the underlying
exchange or queue declare command will be sent in the arguments map.
Examples
--------
A simple name resolves to any named node, usually a queue or a
topic::
my-queue-or-topic
A simple name with a subject will also resolve to a node, but the
presence of the subject will cause a sender using this address to
set the subject on outgoing messages, and receivers to filter based
on the subject::
my-queue-or-topic/my-subject
A subject pattern can be used and will cause filtering if used by
the receiver. If used for a sender, the literal value gets set as
the subject::
my-queue-or-topic/my-*
In all the above cases, the address is resolved to an existing node.
If you want the node to be auto-created, then you can do the
following. By default nonexistent nodes are assumed to be queues::
my-queue; {create: always}
You can customize the properties of the queue::
my-queue; {create: always, node-properties: {durable: True}}
You can create a topic instead if you want::
my-queue; {create: always, node-properties: {type: topic}}
You can assert that the address resolves to a node with particular
properties::
my-transient-topic; {
assert: always,
node-properties: {
type: topic,
durable: False
}
}
"""
def __init__(self, connection, name, transactional):
self.connection = connection
self.name = name
self.log_id = "%x" % id(self)
self.transactional = transactional
self.committing = False
self.committed = True
self.aborting = False
self.aborted = False
self.next_sender_id = 0
self.senders = []
self.next_receiver_id = 0
self.receivers = []
self.outgoing = []
self.incoming = []
self.unacked = []
self.acked = []
# XXX: I hate this name.
self.ack_capacity = UNLIMITED
self.error = None
self.closing = False
self.closed = False
self._lock = connection._lock
def __repr__(self):
return "<Session %s>" % self.name
def _wait(self, predicate, timeout=None):
return self.connection._wait(predicate, timeout=timeout)
def _wakeup(self):
self.connection._wakeup()
def _check_error(self, exc=SessionError):
self.connection._check_error(exc)
if self.error:
raise exc(*self.error)
def _ewait(self, predicate, timeout=None, exc=SessionError):
result = self.connection._ewait(lambda: self.error or predicate(), timeout, exc)
self._check_error(exc)
return result
@synchronized
def sender(self, target, **options):
"""
Creates a L{Sender} that may be used to send L{Messages<Message>}
to the specified target.
@type target: str
@param target: the target to which messages will be sent
@rtype: Sender
@return: a new Sender for the specified target
"""
sender = Sender(self, self.next_sender_id, target, options)
self.next_sender_id += 1
self.senders.append(sender)
self._wakeup()
# XXX: because of the lack of waiting here we can end up getting
# into the driver loop with messages sent for senders that haven't
# been linked yet, something similar can probably happen for
# receivers
return sender
@synchronized
def receiver(self, source, **options):
"""
Creates a receiver that may be used to fetch L{Messages<Message>}
from the specified source.
@type source: str
@param source: the source of L{Messages<Message>}
@rtype: Receiver
@return: a new Receiver for the specified source
"""
receiver = Receiver(self, self.next_receiver_id, source, options)
self.next_receiver_id += 1
self.receivers.append(receiver)
self._wakeup()
return receiver
@synchronized
def _count(self, predicate):
result = 0
for msg in self.incoming:
if predicate(msg):
result += 1
return result
def _peek(self, predicate):
for msg in self.incoming:
if predicate(msg):
return msg
def _pop(self, predicate):
i = 0
while i < len(self.incoming):
msg = self.incoming[i]
if predicate(msg):
del self.incoming[i]
return msg
else:
i += 1
@synchronized
def _get(self, predicate, timeout=None):
if self._ewait(lambda: ((self._peek(predicate) is not None) or self.closing),
timeout):
msg = self._pop(predicate)
if msg is not None:
msg._receiver.returned += 1
self.unacked.append(msg)
log.debug("RETR[%s]: %s", self.log_id, msg)
return msg
return None
@synchronized
def next_receiver(self, timeout=None):
if self._ewait(lambda: self.incoming, timeout):
return self.incoming[0]._receiver
else:
raise Empty
@synchronized
def acknowledge(self, message=None, sync=True):
"""
Acknowledge the given L{Message}. If message is None, then all
unacknowledged messages on the session are acknowledged.
@type message: Message
@param message: the message to acknowledge or None
@type sync: boolean
@param sync: if true then block until the message(s) are acknowledged
"""
if message is None:
messages = self.unacked[:]
else:
messages = [message]
for m in messages:
if self.ack_capacity is not UNLIMITED:
if self.ack_capacity <= 0:
# XXX: this is currently a SendError, maybe it should be a SessionError?
raise InsufficientCapacity("ack_capacity = %s" % self.ack_capacity)
self._wakeup()
self._ewait(lambda: len(self.acked) < self.ack_capacity)
self.unacked.remove(m)
self.acked.append(m)
self._wakeup()
if sync:
self._ewait(lambda: not [m for m in messages if m in self.acked])
@synchronized
def commit(self):
"""
Commit outstanding transactional work. This consists of all
message sends and receives since the prior commit or rollback.
"""
if not self.transactional:
raise NontransactionalSession()
self.committing = True
self._wakeup()
self._ewait(lambda: not self.committing)
if self.aborted:
raise TransactionAborted()
assert self.committed
@synchronized
def rollback(self):
"""
Rollback outstanding transactional work. This consists of all
message sends and receives since the prior commit or rollback.
"""
if not self.transactional:
raise NontransactionalSession()
self.aborting = True
self._wakeup()
self._ewait(lambda: not self.aborting)
assert self.aborted
@synchronized
def close(self):
"""
Close the session.
"""
# XXX: should be able to express this condition through API calls
self._ewait(lambda: not self.outgoing and not self.acked)
for link in self.receivers + self.senders:
link.close()
self.closing = True
self._wakeup()
self._ewait(lambda: self.closed)
self.connection._remove_session(self)
class SendError(SessionError):
pass
class InsufficientCapacity(SendError):
pass
class Sender:
"""
Sends outgoing messages.
"""
def __init__(self, session, id, target, options):
self.session = session
self.id = id
self.target = target
self.options = options
self.capacity = options.get("capacity", UNLIMITED)
self.durable = options.get("durable")
self.queued = Serial(0)
self.acked = Serial(0)
self.error = None
self.linked = False
self.closing = False
self.closed = False
self._lock = self.session._lock
def _wakeup(self):
self.session._wakeup()
def _check_error(self, exc=SendError):
self.session._check_error(exc)
if self.error:
raise exc(*self.error)
def _ewait(self, predicate, timeout=None, exc=SendError):
result = self.session._ewait(lambda: self.error or predicate(), timeout, exc)
self._check_error(exc)
return result
@synchronized
def pending(self):
"""
Returns the number of messages awaiting acknowledgment.
@rtype: int
@return: the number of unacknowledged messages
"""
return self.queued - self.acked
@synchronized
def send(self, object, sync=True, timeout=None):
"""
Send a message. If the object passed in is of type L{unicode},
L{str}, L{list}, or L{dict}, it will automatically be wrapped in a
L{Message} and sent. If it is of type L{Message}, it will be sent
directly. If the sender capacity is not L{UNLIMITED} then send
will block until there is available capacity to send the message.
If the timeout parameter is specified, then send will throw an
L{InsufficientCapacity} exception if capacity does not become
available within the specified time.
@type object: unicode, str, list, dict, Message
@param object: the message or content to send
@type sync: boolean
@param sync: if true then block until the message is sent
@type timeout: float
@param timeout: the time to wait for available capacity
"""
if not self.session.connection._connected or self.session.closing:
raise Disconnected()
self._ewait(lambda: self.linked)
if isinstance(object, Message):
message = object
else:
message = Message(object)
if message.durable is None:
message.durable = self.durable
if self.capacity is not UNLIMITED:
if self.capacity <= 0:
raise InsufficientCapacity("capacity = %s" % self.capacity)
if not self._ewait(lambda: self.pending() < self.capacity, timeout=timeout):
raise InsufficientCapacity("capacity = %s" % self.capacity)
# XXX: what if we send the same message to multiple senders?
message._sender = self
self.session.outgoing.append(message)
self.queued += 1
self._wakeup()
if sync:
self.sync()
assert message not in self.session.outgoing
@synchronized
def sync(self):
mno = self.queued
self._ewait(lambda: self.acked >= mno)
@synchronized
def close(self):
"""
Close the Sender.
"""
self.closing = True
self._wakeup()
try:
self.session._ewait(lambda: self.closed)
finally:
self.session.senders.remove(self)
class ReceiveError(SessionError):
pass
class Empty(ReceiveError):
"""
Exception raised by L{Receiver.fetch} when there is no message
available within the alloted time.
"""
pass
class Receiver(object):
"""
Receives incoming messages from a remote source. Messages may be
fetched with L{fetch}.
"""
def __init__(self, session, id, source, options):
self.session = session
self.id = id
self.source = source
self.options = options
self.granted = Serial(0)
self.draining = False
self.impending = Serial(0)
self.received = Serial(0)
self.returned = Serial(0)
self.error = None
self.linked = False
self.closing = False
self.closed = False
self._lock = self.session._lock
self._capacity = 0
self._set_capacity(options.get("capacity", 0), False)
@synchronized
def _set_capacity(self, c, wakeup=True):
if c is UNLIMITED:
self._capacity = c.value
else:
self._capacity = c
self._grant()
if wakeup:
self._wakeup()
def _get_capacity(self):
if self._capacity == UNLIMITED.value:
return UNLIMITED
else:
return self._capacity
capacity = property(_get_capacity, _set_capacity)
def _wakeup(self):
self.session._wakeup()
def _check_error(self, exc=ReceiveError):
self.session._check_error(exc)
if self.error:
raise exc(*self.error)
def _ewait(self, predicate, timeout=None, exc=ReceiveError):
result = self.session._ewait(lambda: self.error or predicate(), timeout, exc)
self._check_error(exc)
return result
@synchronized
def pending(self):
"""
Returns the number of messages available to be fetched by the
application.
@rtype: int
@return: the number of available messages
"""
return self.received - self.returned
def _pred(self, msg):
return msg._receiver == self
@synchronized
def fetch(self, timeout=None):
"""
Fetch and return a single message. A timeout of None will block
forever waiting for a message to arrive, a timeout of zero will
return immediately if no messages are available.
@type timeout: float
@param timeout: the time to wait for a message to be available
"""
self._ewait(lambda: self.linked)
if self._capacity == 0:
self.granted = self.returned + 1
self._wakeup()
self._ewait(lambda: self.impending >= self.granted)
msg = self.session._get(self._pred, timeout=timeout)
if msg is None:
self.draining = True
self._wakeup()
self._ewait(lambda: not self.draining)
self._grant()
self._wakeup()
msg = self.session._get(self._pred, timeout=0)
if msg is None:
raise Empty()
elif self._capacity not in (0, UNLIMITED.value):
self.granted += 1
self._wakeup()
return msg
def _grant(self):
if self._capacity == UNLIMITED.value:
self.granted = UNLIMITED
else:
self.granted = self.received + self._capacity
@synchronized
def close(self):
"""
Close the receiver.
"""
self.closing = True
self._wakeup()
try:
self.session._ewait(lambda: self.closed)
finally:
self.session.receivers.remove(self)
def codec(name):
type = PRIMITIVE[name]
def encode(x):
sc = StringCodec()
sc.write_primitive(type, x)
return sc.encoded
def decode(x):
sc = StringCodec(x)
return sc.read_primitive(type)
return encode, decode
# XXX: need to correctly parse the mime type and deal with
# content-encoding header
TYPE_MAPPINGS={
dict: "amqp/map",
list: "amqp/list",
unicode: "text/plain; charset=utf8",
unicode: "text/plain",
buffer: None,
str: None,
None.__class__: None
}
TYPE_CODEC={
"amqp/map": codec("map"),
"amqp/list": codec("list"),
"text/plain; charset=utf8": (lambda x: x.encode("utf8"), lambda x: x.decode("utf8")),
"text/plain": (lambda x: x.encode("utf8"), lambda x: x.decode("utf8")),
"": (lambda x: x, lambda x: x),
None: (lambda x: x, lambda x: x)
}
def get_type(content):
return TYPE_MAPPINGS[content.__class__]
def get_codec(content_type):
return TYPE_CODEC[content_type]
UNSPECIFIED = object()
class Message:
"""
A message consists of a standard set of fields, an application
defined set of properties, and some content.
@type id: str
@ivar id: the message id
@type user_id: ???
@ivar user_id: the user-id of the message producer
@type to: ???
@ivar to: ???
@type reply_to: ???
@ivar reply_to: ???
@type correlation_id: str
@ivar correlation_id: a correlation-id for the message
@type properties: dict
@ivar properties: application specific message properties
@type content_type: str
@ivar content_type: the content-type of the message
@type content: str, unicode, buffer, dict, list
@ivar content: the message content
"""
def __init__(self, content=None, content_type=UNSPECIFIED, id=None,
subject=None, to=None, user_id=None, reply_to=None,
correlation_id=None, durable=None, properties=None):
"""
Construct a new message with the supplied content. The
content-type of the message will be automatically inferred from
type of the content parameter.
@type content: str, unicode, buffer, dict, list
@param content: the message content
@type content_type: str
@param content_type: the content-type of the message
"""
self.id = id
self.subject = subject
self.to = to
self.user_id = user_id
self.reply_to = reply_to
self.correlation_id = correlation_id
self.durable = durable
self.redelivered = False
if properties is None:
self.properties = {}
else:
self.properties = properties
if content_type is UNSPECIFIED:
self.content_type = get_type(content)
else:
self.content_type = content_type
self.content = content
def __repr__(self):
args = []
for name in ["id", "subject", "to", "user_id", "reply_to",
"correlation_id"]:
value = self.__dict__[name]
if value is not None: args.append("%s=%r" % (name, value))
for name in ["durable", "properties"]:
value = self.__dict__[name]
if value: args.append("%s=%r" % (name, value))
if self.content_type != get_type(self.content):
args.append("content_type=%r" % self.content_type)
if self.content is not None:
if args:
args.append("content=%r" % self.content)
else:
args.append(repr(self.content))
return "Message(%s)" % ", ".join(args)
__all__ = ["Connection", "Session", "Sender", "Receiver", "Pattern", "Message",
"ConnectionError", "ConnectError", "SessionError", "Disconnected",
"SendError", "InsufficientCapacity", "ReceiveError", "Empty",
"timestamp", "uuid4", "UNLIMITED", "AMQP_PORT", "AMQPS_PORT"]
|