File: proton.reactor.rst

package info (click to toggle)
qpid-proton 0.37.0-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 18,384 kB
  • sloc: ansic: 37,828; cpp: 37,140; python: 15,302; ruby: 6,018; xml: 477; sh: 320; pascal: 52; makefile: 18
file content (205 lines) | stat: -rw-r--r-- 7,765 bytes parent folder | download | duplicates (3)
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
#########################
Module ``proton.reactor``
#########################

.. currentmodule:: proton.reactor

Module Summary
##############

|

+---------------------------+----------------------------------------------------------------------------------------------------+
| :class:`Container`        | A representation of the AMQP concept of a ‘container’, which loosely speaking is something that    |
|                           | establishes links to or from another container, over which messages are transfered.                |
+---------------------------+----------------------------------------------------------------------------------------------------+
| :class:`ApplicationEvent` | Application defined event, which can optionally be associated with an engine object and or an      |
|                           | arbitrary subject.                                                                                 |
+---------------------------+----------------------------------------------------------------------------------------------------+
| :class:`EventInjector`    | Can be added to a :class:`Container` to allow events to be triggered by an external thread but     |
|                           | handled on the event thread associated with the container.                                         |
+---------------------------+----------------------------------------------------------------------------------------------------+
| :class:`Backoff`          | A reconnect strategy involving an increasing delay between retries, up to a maximum or 10 seconds. |
+---------------------------+----------------------------------------------------------------------------------------------------+
| :class:`Transaction`      | Tracks the state of an AMQP 1.0 local transaction.                                                 |
+---------------------------+----------------------------------------------------------------------------------------------------+

|

Link Options
============

|

The methods :meth:`Container.create_receiver` and :meth:`Container.create_sender` take one or more link options to allow the details of the links to be customized.

+--------------------------------+----------------------------------------------------------------------------------+
| :class:`LinkOption`            | Abstract interface for link configuration options.                               |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`ReceiverOption`        | Abstract class for receiver options.                                             |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`SenderOption`          | Abstract class for sender options.                                               |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`AtLeastOnce`           | Set at-least-once delivery semantics for message delivery.                       |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`AtMostOnce`            | Set at-most-once delivery semantics for message delivery.                        |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`DynamicNodeProperties` | Allows a map of link properties to be set on a link.                             |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`Filter`                | Receiver option which allows incoming messages to be filtered.                   |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`Selector`              | Configures a receiver with a message selector filter.                            |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`DurableSubscription`   | Receiver option which sets both the configuration and delivery state to durable. |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`Copy`                  | Receiver option which copies messages to the receiver.                           |
+--------------------------------+----------------------------------------------------------------------------------+
| :class:`Move`                  | Receiver option which moves messages to the receiver (rather than copying).      |
+--------------------------------+----------------------------------------------------------------------------------+

|

Module Detail
#############

|

.. autoclass:: proton.reactor.ApplicationEvent
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: handler

------------

.. autoclass:: proton.reactor.AtLeastOnce
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.AtMostOnce
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.Backoff
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:

------------

.. autoclass:: proton.reactor.Container
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: on_error, global_handler, timeout, yield_, mark, now, handler, wakeup, start, quiesced, process, stop, stop_events, timer_tick, timer_deadline, acceptor, connection, connection_to_host, set_connection_host, get_connection_address, update, push_event

------------

.. autoclass:: proton.reactor.Copy
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.DurableSubscription
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.DynamicNodeProperties
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.EventInjector
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:

------------

.. autoclass:: proton.reactor.Filter
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.LinkOption
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:

------------

.. autoclass:: proton.reactor.Move
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.ReceiverOption
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.Selector
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.SenderOption
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: test

------------

.. autoclass:: proton.reactor.Transaction
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :exclude-members: declare, discharge, update, handle_outcome