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
|
#################
Module ``proton``
#################
.. currentmodule:: proton
Module Summary
##############
|
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`AnnotationDict` | A dictionary that only takes :class:`symbol` or :class:`ulong` types as a key. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Condition` | An AMQP Condition object. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Connection` | A representation of an AMQP connection. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Data` | Provides an interface for decoding, extracting, creating, and encoding arbitrary AMQP data. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Delivery` | Tracks and/or records the delivery of a message over a link. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Disposition` | A delivery state. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Endpoint` | Abstract class from which :class:`Connection`, :class:`Session` and :class:`Link` are derived, |
| | and which defines the state of these classes. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Event` | Notification of a state change in the protocol engine. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`EventType` | Connects an event number to an event name, and is used internally by :class:`Event` to represent|
| | all known event types. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Link` | A representation of an AMQP link (a unidirectional channel for transferring messages), of which |
| | there are two concrete implementations, :class:`Sender` and :class:`Receiver`. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Message` | A mutable holder of message content. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`PropertyDict` | A dictionary that only takes :class:`symbol` types as a key. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Receiver` | A link over which messages are received. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`SASL` | The SASL layer is responsible for establishing an authenticated and/or encrypted tunnel over |
| | which AMQP frames are passed between peers. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Sender` | A link over which messages are sent. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Session` | A container of links. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`SSL` | An SSL session associated with a transport. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`SSLDomain` | An SSL configuration domain, used to hold the SSL configuration for one or more SSL sessions. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`SSLSessionDetails` | Unique identifier for the SSL session. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`SymbolList` | A list that can only hold :class:`symbol` elements. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Terminus` | A source or target for messages. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Transport` | A network channel supporting an AMQP connection. |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :class:`Url` | **DEPRECATED** Simple URL parser/constructor. |
+----------------------------+-------------------------------------------------------------------------------------------------+
|
Exceptions
==========
|
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`ConnectionException` | An exception class raised when exceptions or errors related to a connection arise. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`DataException` | The DataException class is the root of the Data exception hierarchy. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`LinkException` | An exception class raised when exceptions or errors related to a link arise. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`MessageException` | The MessageException class is the root of the message exception hierarchy. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`ProtonException` | The root of the proton exception hierarchy. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`SessionException` | An exception class raised when exceptions or errors related to a session arise. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`SSLUnavailable` | An exception class raised when exceptions or errors related to SSL availability arise. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`SSLException` | An exception class raised when exceptions or errors related to SSL usage arise. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`Timeout` | A timeout exception indicates that a blocking operation has timed out. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`Interrupt` | An interrupt exception indicates that a blocking operation was interrupted. |
+------------------------------+-----------------------------------------------------------------------------------------+
| :class:`TransportException` | An exception class raised when exceptions or errors related to the AMQP transport arise.|
+------------------------------+-----------------------------------------------------------------------------------------+
|
AMQP Types
==========
**NOTE:** Some AMQP types are represented by native Python types. This table contains only classes for non-native
Python types defined in this module. See :ref:`types` for a full list of AMQP types.
|
+---------------------+------------------------------------------------------------+
| :class:`Array` | An AMQP array, a sequence of AMQP values of a single type. |
+---------------------+------------------------------------------------------------+
| :class:`byte` | The byte AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`char` | The char AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`Described` | A described AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`decimal32` | The decimal32 AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`decimal64` | The decimal64 AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`decimal128` | The decimal128 AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`float32` | The float AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`int32` | The signed int AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`short` | The short AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`symbol` | The symbol AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`timestamp` | The timestamp AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`ubyte` | The unsigned byte AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`uint` | The unsigned int AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`ulong` | The ulong AMQP type. |
+---------------------+------------------------------------------------------------+
| :class:`ushort` | The unsigned short AMQP type. |
+---------------------+------------------------------------------------------------+
|
Module Detail
#############
.. The following classes in the __all__ list are excluded (blacklisted):
* Collector
.. autoclass:: proton.AnnotationDict
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Condition
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Connection
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: collect, wrap
------------
.. autoclass:: proton.ConnectionException
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.Data
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: get_mappings, lookup, put_mappings
------------
.. autoclass:: proton.DataException
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.Delivery
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: wrap
------------
.. autoclass:: proton.Disposition
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Described
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Endpoint
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Event
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: wrap
------------
.. autoclass:: proton.EventType
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Link
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: wrap
------------
.. autoclass:: proton.LinkException
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.Message
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: decode, encode
------------
.. autoclass:: proton.MessageException
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.ProtonException
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.PropertyDict
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Receiver
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: wrap
------------
.. autoclass:: proton.SASL
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Sender
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: wrap
------------
.. autoclass:: proton.Session
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: wrap
------------
.. autoclass:: proton.SessionException
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.SSL
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.SSLDomain
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.SSLSessionDetails
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.SSLUnavailable
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.SSLException
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.SymbolList
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Terminus
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.Timeout
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.Interrupt
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.Transport
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: wrap
------------
.. autoclass:: proton.TransportException
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
:exclude-members: args
------------
.. autoclass:: proton.Url
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.Array
:members:
:show-inheritance:
:inherited-members:
:undoc-members:
------------
.. autoclass:: proton.byte
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.char
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.decimal32
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.decimal64
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.decimal128
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.float32
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.int32
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.short
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.symbol
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.timestamp
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.ubyte
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.uint
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.ulong
:members:
:show-inheritance:
:undoc-members:
------------
.. autoclass:: proton.ushort
:members:
:show-inheritance:
:undoc-members:
|
