-
-
Notifications
You must be signed in to change notification settings - Fork 927
/
base.py
209 lines (156 loc) · 6.26 KB
/
base.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
"""
kombu.transport.base
====================
Base transport interface.
:copyright: (c) 2009 - 2012 by Ask Solem.
:license: BSD, see LICENSE for more details.
"""
from __future__ import absolute_import
from .. import serialization
from ..compression import decompress
from ..exceptions import MessageStateError
ACKNOWLEDGED_STATES = frozenset(["ACK", "REJECTED", "REQUEUED"])
class StdChannel(object):
no_ack_consumers = None
def Consumer(self, *args, **kwargs):
from ..messaging import Consumer
return Consumer(self, *args, **kwargs)
def Producer(self, *args, **kwargs):
from ..messaging import Producer
return Producer(self, *args, **kwargs)
def list_bindings(self):
raise NotImplementedError("%r does not implement list_bindings" % (
self.__class__, ))
def after_reply_message_received(self, queue):
"""reply queue semantics: can be used to delete the queue
after transient reply message received."""
pass
class Message(object):
"""Base class for received messages."""
_state = None
MessageStateError = MessageStateError
#: The channel the message was received on.
channel = None
#: Delivery tag used to identify the message in this channel.
delivery_tag = None
#: Content type used to identify the type of content.
content_type = None
#: Content encoding used to identify the text encoding of the body.
content_encoding = None
#: Additional delivery information.
delivery_info = None
#: Message headers
headers = None
#: Application properties
properties = None
#: Raw message body (may be serialized), see :attr:`payload` instead.
body = None
def __init__(self, channel, body=None, delivery_tag=None,
content_type=None, content_encoding=None, delivery_info={},
properties=None, headers=None, postencode=None,
**kwargs):
self.channel = channel
self.body = body
self.delivery_tag = delivery_tag
self.content_type = content_type
self.content_encoding = content_encoding
self.delivery_info = delivery_info
self.headers = headers or {}
self.properties = properties or {}
self._decoded_cache = None
self._state = "RECEIVED"
compression = self.headers.get("compression")
if compression:
self.body = decompress(self.body, compression)
if postencode and isinstance(self.body, unicode):
self.body = self.body.encode(postencode)
def ack(self):
"""Acknowledge this message as being processed.,
This will remove the message from the queue.
:raises MessageStateError: If the message has already been
acknowledged/requeued/rejected.
"""
if self.channel.no_ack_consumers is not None:
try:
consumer_tag = self.delivery_info["consumer_tag"]
except KeyError:
pass
else:
if consumer_tag in self.channel.no_ack_consumers:
return
if self.acknowledged:
raise self.MessageStateError(
"Message already acknowledged with state: %s" % self._state)
self.channel.basic_ack(self.delivery_tag)
self._state = "ACK"
def ack_log_error(self, logger, errors):
try:
self.ack()
except errors, exc:
logger.critical("Couldn't ack %r, reason:%r",
self.delivery_tag, exc, exc_info=True)
def reject(self):
"""Reject this message.
The message will be discarded by the server.
:raises MessageStateError: If the message has already been
acknowledged/requeued/rejected.
"""
if self.acknowledged:
raise self.MessageStateError(
"Message already acknowledged with state: %s" % self._state)
self.channel.basic_reject(self.delivery_tag, requeue=False)
self._state = "REJECTED"
def requeue(self):
"""Reject this message and put it back on the queue.
You must not use this method as a means of selecting messages
to process.
:raises MessageStateError: If the message has already been
acknowledged/requeued/rejected.
"""
if self.acknowledged:
raise self.MessageStateError(
"Message already acknowledged with state: %s" % self._state)
self.channel.basic_reject(self.delivery_tag, requeue=True)
self._state = "REQUEUED"
def decode(self):
"""Deserialize the message body, returning the original
python structure sent by the publisher."""
return serialization.decode(self.body, self.content_type,
self.content_encoding)
@property
def acknowledged(self):
"""Set to true if the message has been acknowledged."""
return self._state in ACKNOWLEDGED_STATES
@property
def payload(self):
"""The decoded message body."""
if not self._decoded_cache:
self._decoded_cache = self.decode()
return self._decoded_cache
class Transport(object):
"""Base class for transports."""
#: The :class:`~kombu.connection.BrokerConnection` owning this instance.
client = None
#: Default port used when no port has been specified.
default_port = None
#: Tuple of errors that can happen due to connection failure.
connection_errors = ()
#: Tuple of errors that can happen due to channel/method failure.
channel_errors = ()
def __init__(self, client, **kwargs):
self.client = client
def establish_connection(self):
raise NotImplementedError("Subclass responsibility")
def close_connection(self, connection):
raise NotImplementedError("Subclass responsibility")
def create_channel(self, connection):
raise NotImplementedError("Subclass responsibility")
def close_channel(self, connection):
raise NotImplementedError("Subclass responsibility")
def drain_events(self, connection, **kwargs):
raise NotImplementedError("Subclass responsibility")
def verify_connection(self, connection):
return True
@property
def default_connection_params(self):
return {}