summaryrefslogtreecommitdiff
path: root/cpp/bindings/qpid/python/python.i
blob: 4d8a64b376db08ff2c4d5d853772b1e05b7b7614 (plain)
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
/*
 * 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.
 */

%module cqpid
%include "std_string.i"
%include "../../swig_python_typemaps.i"

/* Needed for get/setPriority methods.  Surprising SWIG 1.3.40 doesn't
 * convert uint8_t by default. */
%apply unsigned char { uint8_t };


/*
 * Exceptions
 *
 * The convention below is that exceptions in _cqpid.so have the same
 * names as in the C++ library.  They get renamed to their Python
 * equivalents when brought into the Python wrapping
 */
%define QPID_EXCEPTION(exception, parent)
%{
static PyObject* exception;
%}
%init %{
    exception = PyErr_NewException(
        (char *) ("_cqpid." #exception), parent, NULL);
    Py_INCREF(exception);
    PyModule_AddObject(m, #exception, exception);
%}
%pythoncode %{
    exception = _cqpid. ## exception
%}
%enddef

 /* Python equivalents of C++ exceptions.                              */
 /*                                                                    */
 /* Commented out lines are exceptions in the Python library, but not  */
 /* in the C++ library.                                                */

QPID_EXCEPTION(MessagingError, NULL)

QPID_EXCEPTION(LinkError, MessagingError)
QPID_EXCEPTION(AddressError, LinkError)
QPID_EXCEPTION(ResolutionError, AddressError)
QPID_EXCEPTION(AssertionFailed, ResolutionError)
QPID_EXCEPTION(NotFound, ResolutionError)
QPID_EXCEPTION(InvalidOption, LinkError)
QPID_EXCEPTION(MalformedAddress, LinkError)
QPID_EXCEPTION(ReceiverError, LinkError)
QPID_EXCEPTION(FetchError, ReceiverError)
QPID_EXCEPTION(Empty, FetchError)
/* QPID_EXCEPTION(InsufficientCapacity, LinkError) */
/* QPID_EXCEPTION(LinkClosed, LinkError) */
QPID_EXCEPTION(SenderError, LinkError)
QPID_EXCEPTION(SendError, SenderError)
QPID_EXCEPTION(TargetCapacityExceeded, SendError)

QPID_EXCEPTION(ConnectionError, MessagingError)
QPID_EXCEPTION(ConnectError, ConnectionError)
/* QPID_EXCEPTION(AuthenticationFailure, ConnectError) */
/* QPID_EXCEPTION(VersionError, ConnectError) */
/* QPID_EXCEPTION(ConnectionClosed, ConnectionError) */
/* QPID_EXCEPTION(HeartbeartTimeout, ConnectionError) */

QPID_EXCEPTION(SessionError, MessagingError)
/* QPID_EXCEPTION(Detached, SessionError) */
/* QPID_EXCEPTION(NontransactionalSession, SessionError) */
/* QPID_EXCEPTION(ServerError, SessionError) */
/* QPID_EXCEPTION(SessionClosed, SessionError) */
QPID_EXCEPTION(TransactionError, SessionError)
QPID_EXCEPTION(TransactionAborted, TransactionError)
QPID_EXCEPTION(UnauthorizedAccess, SessionError)

/* QPID_EXCEPTION(InternalError, MessagingError) */

%define TRANSLATE_EXCEPTION(cpp_exception, py_exception)
    catch ( cpp_exception & ex) {
        pExceptionType = py_exception;
        error = ex.what();
    }
%enddef

/* Define the general-purpose exception handling */
%exception {
    PyObject * pExceptionType = NULL;
    std::string error;
    Py_BEGIN_ALLOW_THREADS;
    try {
        $action
    }
    /* Catch and translate exceptions. */
    TRANSLATE_EXCEPTION(qpid::messaging::NoMessageAvailable, Empty)
    TRANSLATE_EXCEPTION(qpid::messaging::NotFound, NotFound)
    TRANSLATE_EXCEPTION(qpid::messaging::AssertionFailed, AssertionFailed)
    TRANSLATE_EXCEPTION(qpid::messaging::ResolutionError, ResolutionError)
    TRANSLATE_EXCEPTION(qpid::messaging::TargetCapacityExceeded,
                        TargetCapacityExceeded)
    TRANSLATE_EXCEPTION(qpid::messaging::TransportFailure, ConnectError)
    TRANSLATE_EXCEPTION(qpid::messaging::MalformedAddress, MalformedAddress)
    TRANSLATE_EXCEPTION(qpid::messaging::AddressError, AddressError)
    TRANSLATE_EXCEPTION(qpid::messaging::FetchError, FetchError)
    TRANSLATE_EXCEPTION(qpid::messaging::ReceiverError, ReceiverError)
    TRANSLATE_EXCEPTION(qpid::messaging::SendError, SendError)
    TRANSLATE_EXCEPTION(qpid::messaging::SenderError, SenderError)
    TRANSLATE_EXCEPTION(qpid::messaging::InvalidOptionString, InvalidOption)
    TRANSLATE_EXCEPTION(qpid::messaging::LinkError, LinkError)
    TRANSLATE_EXCEPTION(qpid::messaging::TransactionAborted, TransactionAborted)
    TRANSLATE_EXCEPTION(qpid::messaging::TransactionError, TransactionError)
    TRANSLATE_EXCEPTION(qpid::messaging::UnauthorizedAccess, UnauthorizedAccess)
    TRANSLATE_EXCEPTION(qpid::messaging::SessionError, SessionError)
    TRANSLATE_EXCEPTION(qpid::messaging::ConnectionError, ConnectionError)
    TRANSLATE_EXCEPTION(qpid::messaging::KeyError, PyExc_KeyError)
    TRANSLATE_EXCEPTION(qpid::messaging::MessagingException, MessagingError)
    TRANSLATE_EXCEPTION(qpid::types::Exception, PyExc_RuntimeError)
    Py_END_ALLOW_THREADS;
    if (!error.empty()) {
        PyErr_SetString(pExceptionType, error.c_str());
        return NULL;
    }
}


/* This only renames the non-const version (I believe).  Then again, I
 * don't even know why there is a non-const version of the method. */
%rename(opened) qpid::messaging::Connection::isOpen();
%rename(receiver) qpid::messaging::Session::createReceiver;
%rename(sender) qpid::messaging::Session::createSender;
%rename(_acknowledge_all) qpid::messaging::Session::acknowledge(bool);
%rename(_acknowledge_msg) qpid::messaging::Session::acknowledge(
    Message &, bool);

%rename(_fetch) qpid::messaging::Receiver::fetch;
%rename(unsettled) qpid::messaging::Receiver::getUnsettled;
%rename(available) qpid::messaging::Receiver::getAvailable;

%rename(unsettled) qpid::messaging::Sender::getUnsettled;
%rename(available) qpid::messaging::Sender::getAvailable;
%rename(_send) qpid::messaging::Sender::send;

%rename(_getReplyTo) qpid::messaging::Message::getReplyTo;
%rename(_setReplyTo) qpid::messaging::Message::setReplyTo;
%rename(_getTtl) qpid::messaging::Message::getTtl;
%rename(_setTtl) qpid::messaging::Message::setTtl;


%include "../qpid.i"

%extend qpid::messaging::Connection {
    %pythoncode %{
         # Handle the different options by converting underscores to hyphens.
         # Also, the sasl_mechanisms option in Python has no direct
         # equivalent in C++, so we will translate them to sasl_mechanism
         # when possible.
         def __init__(self, url=None, **options):
             if url:
                 args = [url]
             else:
                 args = []
             if options :
                 if "sasl_mechanisms" in options :
                     if ' ' in options.get("sasl_mechanisms",'') :
                         raise Exception(
                             "C++ Connection objects are unable to handle "
                             "multiple sasl-mechanisms")
                     options["sasl_mechanism"] = options.pop("sasl_mechanisms")
                 args.append(options)
             this = _cqpid.new_Connection(*args)
             try: self.this.append(this)
             except: self.this = this
    %}

    /* Return a pre-existing session with the given name, if one
     * exists, otherwise return a new one.  (Note that if a
     * pre-existing session exists, the transactional argument is
     * ignored, and the returned session might not satisfy the desired
     * setting. */
    qpid::messaging::Session _session(const std::string & name,
                                     bool transactional) {
        if (!name.empty()) {
            try {
                return self->getSession(name);
            }
            catch (const qpid::messaging::KeyError &) {
            }
        }
        if (transactional) {
            return self->createTransactionalSession(name);
        }
        else {
            return self->createSession(name);
        }
    }

    %pythoncode %{
        def session(self, name=None, transactional=False) :
            if name is None :
                name = ''
            return self._session(name, transactional)
    %}

    %pythoncode %{
        @staticmethod
        def establish(url=None, **options) :
            conn = Connection(url, **options)
            conn.open()
            return conn
    %}
}

%extend qpid::messaging::Session {
    %pythoncode %{
         def acknowledge(self, message=None, disposition=None, sync=True) :
             if disposition :
                 raise Exception("SWIG does not support dispositions yet. Use "
                                 "Session.reject and Session.release instead")
             if message :
                 self._acknowledge_msg(message, sync)
             else :
                 self._acknowledge_all(sync)

         __swig_getmethods__["connection"] = getConnection
         if _newclass: connection = property(getConnection)
    %}
}


%extend qpid::messaging::Receiver {
    %pythoncode %{
         __swig_getmethods__["capacity"] = getCapacity
         __swig_setmethods__["capacity"] = setCapacity
         if _newclass: capacity = property(getCapacity, setCapacity)

         __swig_getmethods__["session"] = getSession
         if _newclass: session = property(getSession)
    %}

    %pythoncode %{
         def fetch(self, timeout=None) :
             if timeout is None :
                 return self._fetch()
             else :
                 # Python API uses timeouts in seconds,
                 # but C++ API uses milliseconds
                 return self._fetch(Duration(int(1000*timeout)))
    %}
}

%extend qpid::messaging::Sender {
    %pythoncode %{
         def send(self, object, sync=True) :
             if isinstance(object, Message):
                 message = object
             else:
                 message = Message(object)
             return self._send(message, sync)
         
         __swig_getmethods__["capacity"] = getCapacity
         __swig_setmethods__["capacity"] = setCapacity
         if _newclass: capacity = property(getCapacity, setCapacity)

         __swig_getmethods__["session"] = getSession
         if _newclass: session = property(getSession)
    %}
}


%extend qpid::messaging::Message {
    %pythoncode %{
         # UNSPECIFIED was module level before, but I do not
         # know how to insert python code at the top of the module.
         # (A bare "%pythoncode" inserts at the end.
         UNSPECIFIED=object()
         def __init__(self, content=None, content_type=UNSPECIFIED, id=None,
                      subject=None, user_id=None, reply_to=None,
                      correlation_id=None, durable=None, priority=None,
                      ttl=None, properties=None):
             this = _cqpid.new_Message('')
             try: self.this.append(this)
             except: self.this = this
             if content :
                 self.content = content
             if content_type != UNSPECIFIED :
                 self.content_type = content_type
             if id is not None :
                 self.id = id
             if subject is not None :
                 self.subject = subject
             if user_id is not None :
                 self.user_id = user_id
             if reply_to is not None :
                 self.reply_to = reply_to
             if correlation_id is not None :
                 self.correlation_id = correlation_id
             if durable is not None :
                 self.durable = durable
             if priority is not None :
                 self.priority = priority
             if ttl is not None :
                 self.ttl = ttl
             if properties is not None :
                 # Can't set properties via (inst).getProperties, because
                 # the typemaps make a copy of the underlying properties.
                 # Instead, set via setProperty for the time-being
                 for k, v in properties.iteritems() :
                     self.setProperty(k, v)

         def _get_content(self) :
             if self.content_type == "amqp/list" :
                 return decodeList(self)
             if self.content_type == "amqp/map" :
                 return decodeMap(self)
             return self.getContent()
         def _set_content(self, content) :
             if isinstance(content, basestring) :
                 self.setContent(content)
             elif isinstance(content, list) or isinstance(content, dict) :
                 encode(content, self)
             else :
                 # Not a type we can handle.  Try setting it anyway,
                 # although this will probably lead to a swig error
                 self.setContent(content)
         __swig_getmethods__["content"] = _get_content
         __swig_setmethods__["content"] = _set_content
         if _newclass: content = property(_get_content, _set_content)

         __swig_getmethods__["content_type"] = getContentType
         __swig_setmethods__["content_type"] = setContentType
         if _newclass: content_type = property(getContentType, setContentType)

         __swig_getmethods__["id"] = getMessageId
         __swig_setmethods__["id"] = setMessageId
         if _newclass: id = property(getMessageId, setMessageId)

         __swig_getmethods__["subject"] = getSubject
         __swig_setmethods__["subject"] = setSubject
         if _newclass: subject = property(getSubject, setSubject)

         __swig_getmethods__["priority"] = getPriority
         __swig_setmethods__["priority"] = setPriority
         if _newclass: priority = property(getPriority, setPriority)

         def getTtl(self) :
             return self._getTtl().getMilliseconds()/1000.0
         def setTtl(self, duration) :
             self._setTtl(Duration(int(1000*duration)))
         __swig_getmethods__["ttl"] = getTtl
         __swig_setmethods__["ttl"] = setTtl
         if _newclass: ttl = property(getTtl, setTtl)

         __swig_getmethods__["user_id"] = getUserId
         __swig_setmethods__["user_id"] = setUserId
         if _newclass: user_id = property(getUserId, setUserId)

         __swig_getmethods__["correlation_id"] = getCorrelationId
         __swig_setmethods__["correlation_id"] = setCorrelationId
         if _newclass: correlation_id = property(getCorrelationId, setCorrelationId)

         __swig_getmethods__["redelivered"] = getRedelivered
         __swig_setmethods__["redelivered"] = setRedelivered
         if _newclass: redelivered = property(getRedelivered, setRedelivered)

         __swig_getmethods__["durable"] = getDurable
         __swig_setmethods__["durable"] = setDurable
         if _newclass: durable = property(getDurable, setDurable)

         __swig_getmethods__["properties"] = getProperties
         if _newclass: properties = property(getProperties)

         def getReplyTo(self) :
             return self._getReplyTo().str()
         def setReplyTo(self, address_str) :
             self._setReplyTo(Address(address_str))
         __swig_getmethods__["reply_to"] = getReplyTo
         __swig_setmethods__["reply_to"] = setReplyTo
         if _newclass: reply_to = property(getReplyTo, setReplyTo)
         
         def __repr__(self):
             args = []
             for name in ["id", "subject", "user_id", "reply_to",
                          "correlation_id", "priority", "ttl",
                          "durable", "redelivered", "properties",
                          "content_type"] :
                 value = getattr(self, name)
                 if value : args.append("%s=%r" % (name, value))
             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)
    %}
}

%pythoncode %{
# Bring into module scope
UNSPECIFIED = Message.UNSPECIFIED
%}