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
|
<!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>kombu.transport.virtual — Kombu 2.0.0 documentation</title>
<link rel="stylesheet" href="../_static/celery.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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="top" title="Kombu 2.0.0 documentation" href="../index.html" />
<link rel="up" title="API Reference" href="index.html" />
<link rel="next" title="kombu.transport.virtual.exchange" href="kombu.transport.virtual.exchange.html" />
<link rel="prev" title="kombu.transport.base" href="kombu.transport.base.html" />
</head>
<body>
<div class="related">
<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="kombu.transport.virtual.exchange.html" title="kombu.transport.virtual.exchange"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="kombu.transport.base.html" title="kombu.transport.base"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Kombu 2.0.0 documentation</a> »</li>
<li><a href="index.html" accesskey="U">API Reference</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<span class="target" id="module-kombu.transport.virtual"></span><div class="section" id="kombu-transport-virtual">
<h1>kombu.transport.virtual<a class="headerlink" href="#kombu-transport-virtual" title="Permalink to this headline">¶</a></h1>
<p>Virtual transport implementation.</p>
<p>Emulates the AMQ API for non-AMQ transports.</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">copyright:</th><td class="field-body"><ol class="first loweralpha simple" start="3">
<li>2009, 2012 by Ask Solem.</li>
</ol>
</td>
</tr>
<tr class="field-even field"><th class="field-name">license:</th><td class="field-body"><p class="first last">BSD, see LICENSE for more details.</p>
</td>
</tr>
</tbody>
</table>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#transports" id="id1">Transports</a></li>
<li><a class="reference internal" href="#channel" id="id2">Channel</a></li>
<li><a class="reference internal" href="#message" id="id3">Message</a></li>
<li><a class="reference internal" href="#quality-of-service" id="id4">Quality Of Service</a></li>
<li><a class="reference internal" href="#in-memory-state" id="id5">In-memory State</a></li>
</ul>
</div>
<div class="section" id="transports">
<h2><a class="toc-backref" href="#id1">Transports</a><a class="headerlink" href="#transports" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="kombu.transport.virtual.Transport">
<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.</tt><tt class="descname">Transport</tt><big>(</big><em>client</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Transport" title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual transport.</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>client</strong> – <a class="reference internal" href="kombu.connection.html#kombu.connection.BrokerConnection" title="kombu.connection.BrokerConnection"><tt class="xref py py-class docutils literal"><span class="pre">BrokerConnection</span></tt></a> instance</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="kombu.transport.virtual.Transport.Channel">
<tt class="descname">Channel</tt><em class="property"> = <class 'kombu.transport.virtual.Channel'></em><a class="headerlink" href="#kombu.transport.virtual.Transport.Channel" title="Permalink to this definition">¶</a></dt>
<dd><p>channel class used.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Transport.Cycle">
<tt class="descname">Cycle</tt><em class="property"> = <class 'kombu.transport.virtual.scheduling.FairCycle'></em><a class="headerlink" href="#kombu.transport.virtual.Transport.Cycle" title="Permalink to this definition">¶</a></dt>
<dd><p>cycle class used.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Transport.interval">
<tt class="descname">interval</tt><em class="property"> = 1</em><a class="headerlink" href="#kombu.transport.virtual.Transport.interval" title="Permalink to this definition">¶</a></dt>
<dd><p>default interval between polling channels for new events.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Transport.default_port">
<tt class="descname">default_port</tt><em class="property"> = None</em><a class="headerlink" href="#kombu.transport.virtual.Transport.default_port" title="Permalink to this definition">¶</a></dt>
<dd><p>port number used when no port is specified.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Transport.state">
<tt class="descname">state</tt><em class="property"> = <kombu.transport.virtual.BrokerState object at 0x103d2a850></em><a class="headerlink" href="#kombu.transport.virtual.Transport.state" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="#kombu.transport.virtual.BrokerState" title="kombu.transport.virtual.BrokerState"><tt class="xref py py-class docutils literal"><span class="pre">BrokerState</span></tt></a> containing declared exchanges and
bindings (set by constructor).</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Transport.cycle">
<tt class="descname">cycle</tt><em class="property"> = None</em><a class="headerlink" href="#kombu.transport.virtual.Transport.cycle" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="kombu.transport.virtual.scheduling.html#kombu.transport.virtual.scheduling.FairCycle" title="kombu.transport.virtual.scheduling.FairCycle"><tt class="xref py py-class docutils literal"><span class="pre">FairCycle</span></tt></a> instance
used to fairly drain events from channels (set by constructor).</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Transport.establish_connection">
<tt class="descname">establish_connection</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Transport.establish_connection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Transport.close_connection">
<tt class="descname">close_connection</tt><big>(</big><em>connection</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Transport.close_connection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Transport.create_channel">
<tt class="descname">create_channel</tt><big>(</big><em>connection</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Transport.create_channel" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Transport.close_channel">
<tt class="descname">close_channel</tt><big>(</big><em>channel</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Transport.close_channel" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Transport.drain_events">
<tt class="descname">drain_events</tt><big>(</big><em>connection</em>, <em>timeout=None</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Transport.drain_events" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="channel">
<h2><a class="toc-backref" href="#id2">Channel</a><a class="headerlink" href="#channel" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="kombu.transport.virtual.AbstractChannel">
<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.</tt><tt class="descname">AbstractChannel</tt><a class="headerlink" href="#kombu.transport.virtual.AbstractChannel" title="Permalink to this definition">¶</a></dt>
<dd><p>This is an abstract class defining the channel methods
you’d usually want to implement in a virtual channel.</p>
<p>Do not subclass directly, but rather inherit from <a class="reference internal" href="#kombu.transport.virtual.Channel" title="kombu.transport.virtual.Channel"><tt class="xref py py-class docutils literal"><span class="pre">Channel</span></tt></a>
instead.</p>
</dd></dl>
<dl class="class">
<dt id="kombu.transport.virtual.Channel">
<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.</tt><tt class="descname">Channel</tt><big>(</big><em>connection</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Virtual channel.</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>connection</strong> – The transport instance this channel is part of.</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="kombu.transport.virtual.Channel.Message">
<tt class="descname">Message</tt><em class="property"> = <class 'kombu.transport.virtual.Message'></em><a class="headerlink" href="#kombu.transport.virtual.Channel.Message" title="Permalink to this definition">¶</a></dt>
<dd><p>message class used.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Channel.state">
<tt class="descname">state</tt><a class="headerlink" href="#kombu.transport.virtual.Channel.state" title="Permalink to this definition">¶</a></dt>
<dd><p>Broker state containing exchanges and bindings.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Channel.qos">
<tt class="descname">qos</tt><a class="headerlink" href="#kombu.transport.virtual.Channel.qos" title="Permalink to this definition">¶</a></dt>
<dd><p><a class="reference internal" href="#kombu.transport.virtual.QoS" title="kombu.transport.virtual.QoS"><tt class="xref py py-class docutils literal"><span class="pre">QoS</span></tt></a> manager for this channel.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Channel.do_restore">
<tt class="descname">do_restore</tt><em class="property"> = True</em><a class="headerlink" href="#kombu.transport.virtual.Channel.do_restore" title="Permalink to this definition">¶</a></dt>
<dd><p>flag to restore unacked messages when channel
goes out of scope.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Channel.exchange_types">
<tt class="descname">exchange_types</tt><em class="property"> = {'topic': <class 'kombu.transport.virtual.exchange.TopicExchange'>, 'fanout': <class 'kombu.transport.virtual.exchange.FanoutExchange'>, 'direct': <class 'kombu.transport.virtual.exchange.DirectExchange'>}</em><a class="headerlink" href="#kombu.transport.virtual.Channel.exchange_types" title="Permalink to this definition">¶</a></dt>
<dd><p>mapping of exchange types and corresponding classes.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.exchange_declare">
<tt class="descname">exchange_declare</tt><big>(</big><em>exchange</em>, <em>type='direct'</em>, <em>durable=False</em>, <em>auto_delete=False</em>, <em>arguments=None</em>, <em>nowait=False</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.exchange_declare" title="Permalink to this definition">¶</a></dt>
<dd><p>Declare exchange.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.exchange_delete">
<tt class="descname">exchange_delete</tt><big>(</big><em>exchange</em>, <em>if_unused=False</em>, <em>nowait=False</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.exchange_delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete <cite>exchange</cite> and all its bindings.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.queue_declare">
<tt class="descname">queue_declare</tt><big>(</big><em>queue</em>, <em>passive=False</em>, <em>auto_delete=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.queue_declare" title="Permalink to this definition">¶</a></dt>
<dd><p>Declare queue.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.queue_delete">
<tt class="descname">queue_delete</tt><big>(</big><em>queue</em>, <em>if_unusued=False</em>, <em>if_empty=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.queue_delete" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete queue.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.queue_bind">
<tt class="descname">queue_bind</tt><big>(</big><em>queue</em>, <em>exchange</em>, <em>routing_key=''</em>, <em>arguments=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.queue_bind" title="Permalink to this definition">¶</a></dt>
<dd><p>Bind <cite>queue</cite> to <cite>exchange</cite> with <cite>routing key</cite>.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.queue_purge">
<tt class="descname">queue_purge</tt><big>(</big><em>queue</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.queue_purge" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove all ready messages from queue.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.basic_publish">
<tt class="descname">basic_publish</tt><big>(</big><em>message</em>, <em>exchange</em>, <em>routing_key</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.basic_publish" title="Permalink to this definition">¶</a></dt>
<dd><p>Publish message.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.basic_consume">
<tt class="descname">basic_consume</tt><big>(</big><em>queue</em>, <em>no_ack</em>, <em>callback</em>, <em>consumer_tag</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.basic_consume" title="Permalink to this definition">¶</a></dt>
<dd><p>Consume from <cite>queue</cite></p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.basic_cancel">
<tt class="descname">basic_cancel</tt><big>(</big><em>consumer_tag</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.basic_cancel" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel consumer by consumer tag.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.basic_get">
<tt class="descname">basic_get</tt><big>(</big><em>queue</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.basic_get" title="Permalink to this definition">¶</a></dt>
<dd><p>Get message by direct access (synchronous).</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.basic_ack">
<tt class="descname">basic_ack</tt><big>(</big><em>delivery_tag</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.basic_ack" title="Permalink to this definition">¶</a></dt>
<dd><p>Acknowledge message.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.basic_recover">
<tt class="descname">basic_recover</tt><big>(</big><em>requeue=False</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.basic_recover" title="Permalink to this definition">¶</a></dt>
<dd><p>Recover unacked messages.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.basic_reject">
<tt class="descname">basic_reject</tt><big>(</big><em>delivery_tag</em>, <em>requeue=False</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.basic_reject" title="Permalink to this definition">¶</a></dt>
<dd><p>Reject message.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.basic_qos">
<tt class="descname">basic_qos</tt><big>(</big><em>prefetch_size=0</em>, <em>prefetch_count=0</em>, <em>apply_global=False</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.basic_qos" title="Permalink to this definition">¶</a></dt>
<dd><p>Change QoS settings for this channel.</p>
<p>Only <cite>prefetch_count</cite> is supported.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.get_table">
<tt class="descname">get_table</tt><big>(</big><em>exchange</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.get_table" title="Permalink to this definition">¶</a></dt>
<dd><p>Get table of bindings for <cite>exchange</cite>.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.typeof">
<tt class="descname">typeof</tt><big>(</big><em>exchange</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.typeof" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the exchange type instance for <cite>exchange</cite>.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.drain_events">
<tt class="descname">drain_events</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.drain_events" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.prepare_message">
<tt class="descname">prepare_message</tt><big>(</big><em>message_data</em>, <em>priority=None</em>, <em>content_type=None</em>, <em>content_encoding=None</em>, <em>headers=None</em>, <em>properties=None</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.prepare_message" title="Permalink to this definition">¶</a></dt>
<dd><p>Prepare message data.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.message_to_python">
<tt class="descname">message_to_python</tt><big>(</big><em>raw_message</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.message_to_python" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert raw message to <a class="reference internal" href="#kombu.transport.virtual.Message" title="kombu.transport.virtual.Message"><tt class="xref py py-class docutils literal"><span class="pre">Message</span></tt></a> instance.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.flow">
<tt class="descname">flow</tt><big>(</big><em>active=True</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.flow" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable/disable message flow.</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" colspan="2">Raises NotImplementedError:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">as flow
is not implemented by the base virtual implementation.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Channel.close">
<tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Channel.close" title="Permalink to this definition">¶</a></dt>
<dd><p>Close channel, cancel all consumers, and requeue unacked
messages.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="message">
<h2><a class="toc-backref" href="#id3">Message</a><a class="headerlink" href="#message" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="kombu.transport.virtual.Message">
<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.</tt><tt class="descname">Message</tt><big>(</big><em>channel</em>, <em>payload</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Message" title="Permalink to this definition">¶</a></dt>
<dd><dl class="exception">
<dt id="kombu.transport.virtual.Message.MessageStateError">
<em class="property">exception </em><tt class="descname">MessageStateError</tt><a class="headerlink" href="#kombu.transport.virtual.Message.MessageStateError" title="Permalink to this definition">¶</a></dt>
<dd><p>The message has already been acknowledged.</p>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.MessageStateError.args">
<tt class="descname">args</tt><a class="headerlink" href="#kombu.transport.virtual.Message.MessageStateError.args" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.MessageStateError.message">
<tt class="descname">message</tt><a class="headerlink" href="#kombu.transport.virtual.Message.MessageStateError.message" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Message.ack">
<tt class="descclassname">Message.</tt><tt class="descname">ack</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Message.ack" title="Permalink to this definition">¶</a></dt>
<dd><p>Acknowledge this message as being processed.,
This will remove the message from the 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" colspan="2">Raises MessageStateError:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">If the message has already been
acknowledged/requeued/rejected.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Message.ack_log_error">
<tt class="descclassname">Message.</tt><tt class="descname">ack_log_error</tt><big>(</big><em>logger</em>, <em>errors</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Message.ack_log_error" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.acknowledged">
<tt class="descclassname">Message.</tt><tt class="descname">acknowledged</tt><a class="headerlink" href="#kombu.transport.virtual.Message.acknowledged" title="Permalink to this definition">¶</a></dt>
<dd><p>Set to true if the message has been acknowledged.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.body">
<tt class="descclassname">Message.</tt><tt class="descname">body</tt><a class="headerlink" href="#kombu.transport.virtual.Message.body" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.channel">
<tt class="descclassname">Message.</tt><tt class="descname">channel</tt><a class="headerlink" href="#kombu.transport.virtual.Message.channel" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.content_encoding">
<tt class="descclassname">Message.</tt><tt class="descname">content_encoding</tt><a class="headerlink" href="#kombu.transport.virtual.Message.content_encoding" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.content_type">
<tt class="descclassname">Message.</tt><tt class="descname">content_type</tt><a class="headerlink" href="#kombu.transport.virtual.Message.content_type" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Message.decode">
<tt class="descclassname">Message.</tt><tt class="descname">decode</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Message.decode" title="Permalink to this definition">¶</a></dt>
<dd><p>Deserialize the message body, returning the original
python structure sent by the publisher.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.delivery_info">
<tt class="descclassname">Message.</tt><tt class="descname">delivery_info</tt><a class="headerlink" href="#kombu.transport.virtual.Message.delivery_info" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.delivery_tag">
<tt class="descclassname">Message.</tt><tt class="descname">delivery_tag</tt><a class="headerlink" href="#kombu.transport.virtual.Message.delivery_tag" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.headers">
<tt class="descclassname">Message.</tt><tt class="descname">headers</tt><a class="headerlink" href="#kombu.transport.virtual.Message.headers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.payload">
<tt class="descclassname">Message.</tt><tt class="descname">payload</tt><a class="headerlink" href="#kombu.transport.virtual.Message.payload" title="Permalink to this definition">¶</a></dt>
<dd><p>The decoded message body.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.Message.properties">
<tt class="descclassname">Message.</tt><tt class="descname">properties</tt><a class="headerlink" href="#kombu.transport.virtual.Message.properties" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Message.reject">
<tt class="descclassname">Message.</tt><tt class="descname">reject</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Message.reject" title="Permalink to this definition">¶</a></dt>
<dd><p>Reject this message.</p>
<p>The message will be discarded 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" colspan="2">Raises MessageStateError:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">If the message has already been
acknowledged/requeued/rejected.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Message.requeue">
<tt class="descclassname">Message.</tt><tt class="descname">requeue</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Message.requeue" title="Permalink to this definition">¶</a></dt>
<dd><p>Reject this message and put it back on the queue.</p>
<p>You must not use this method as a means of selecting messages
to process.</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" colspan="2">Raises MessageStateError:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">If the message has already been
acknowledged/requeued/rejected.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.Message.serializable">
<tt class="descclassname">Message.</tt><tt class="descname">serializable</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.Message.serializable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="quality-of-service">
<h2><a class="toc-backref" href="#id4">Quality Of Service</a><a class="headerlink" href="#quality-of-service" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="kombu.transport.virtual.QoS">
<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.</tt><tt class="descname">QoS</tt><big>(</big><em>channel</em>, <em>prefetch_count=0</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.QoS" title="Permalink to this definition">¶</a></dt>
<dd><p>Quality of Service guarantees.</p>
<p>Only supports <cite>prefetch_count</cite> at this point.</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>channel</strong> – AMQ Channel.</li>
<li><strong>prefetch_count</strong> – Initial prefetch count (defaults to 0).</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="kombu.transport.virtual.QoS.ack">
<tt class="descname">ack</tt><big>(</big><em>delivery_tag</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.QoS.ack" title="Permalink to this definition">¶</a></dt>
<dd><p>Acknowledge message and remove from transactional state.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.QoS.append">
<tt class="descname">append</tt><big>(</big><em>message</em>, <em>delivery_tag</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.QoS.append" title="Permalink to this definition">¶</a></dt>
<dd><p>Append message to transactional state.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.QoS.can_consume">
<tt class="descname">can_consume</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.QoS.can_consume" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if the channel can be consumed from.</p>
<p>Used to ensure the client adhers to currently active
prefetch limits.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.QoS.get">
<tt class="descname">get</tt><big>(</big><em>delivery_tag</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.QoS.get" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.QoS.prefetch_count">
<tt class="descname">prefetch_count</tt><em class="property"> = 0</em><a class="headerlink" href="#kombu.transport.virtual.QoS.prefetch_count" title="Permalink to this definition">¶</a></dt>
<dd><p>current prefetch count value</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.QoS.reject">
<tt class="descname">reject</tt><big>(</big><em>delivery_tag</em>, <em>requeue=False</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.QoS.reject" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove from transactional state and requeue message.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.QoS.restore_unacked">
<tt class="descname">restore_unacked</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.QoS.restore_unacked" title="Permalink to this definition">¶</a></dt>
<dd><p>Restore all unacknowledged messages.</p>
</dd></dl>
<dl class="method">
<dt id="kombu.transport.virtual.QoS.restore_unacked_once">
<tt class="descname">restore_unacked_once</tt><big>(</big><big>)</big><a class="headerlink" href="#kombu.transport.virtual.QoS.restore_unacked_once" title="Permalink to this definition">¶</a></dt>
<dd><p>Restores all uncknowledged message at shutdown/gc collect.</p>
<p>Will only be done once for each instance.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="in-memory-state">
<h2><a class="toc-backref" href="#id5">In-memory State</a><a class="headerlink" href="#in-memory-state" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="kombu.transport.virtual.BrokerState">
<em class="property">class </em><tt class="descclassname">kombu.transport.virtual.</tt><tt class="descname">BrokerState</tt><big>(</big><em>exchanges=None</em>, <em>bindings=None</em><big>)</big><a class="headerlink" href="#kombu.transport.virtual.BrokerState" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="kombu.transport.virtual.BrokerState.bindings">
<tt class="descname">bindings</tt><em class="property"> = None</em><a class="headerlink" href="#kombu.transport.virtual.BrokerState.bindings" title="Permalink to this definition">¶</a></dt>
<dd><p>active bindings.</p>
</dd></dl>
<dl class="attribute">
<dt id="kombu.transport.virtual.BrokerState.exchanges">
<tt class="descname">exchanges</tt><em class="property"> = None</em><a class="headerlink" href="#kombu.transport.virtual.BrokerState.exchanges" title="Permalink to this definition">¶</a></dt>
<dd><p>exchange declarations.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><p class="logo"><a href="../index.html">
<img class="logo" width="128" height="128" src="http://cloud.github.com/downloads/ask/kombu/kombusmall.jpg" alt="Logo"/>
</a></p>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">kombu.transport.virtual</a><ul>
<li><a class="reference internal" href="#transports">Transports</a></li>
<li><a class="reference internal" href="#channel">Channel</a></li>
<li><a class="reference internal" href="#message">Message</a></li>
<li><a class="reference internal" href="#quality-of-service">Quality Of Service</a></li>
<li><a class="reference internal" href="#in-memory-state">In-memory State</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="kombu.transport.base.html"
title="previous chapter">kombu.transport.base</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="kombu.transport.virtual.exchange.html"
title="next chapter">kombu.transport.virtual.exchange</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/reference/kombu.transport.virtual.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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="kombu.transport.virtual.exchange.html" title="kombu.transport.virtual.exchange"
>next</a> |</li>
<li class="right" >
<a href="kombu.transport.base.html" title="kombu.transport.base"
>previous</a> |</li>
<li><a href="../index.html">Kombu 2.0.0 documentation</a> »</li>
<li><a href="index.html" >API Reference</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2012, Ask Solem.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
</div>
</body>
</html>
|
