Skip to content

Commit e6a825d

Browse files
Adjusted documentation to follow new API.
1 parent 5f8d24d commit e6a825d

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

doc/src/aq.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Advanced Queuing
1414
Queues
1515
------
1616

17-
Queues are created using the :meth:`Connection.queue()` method and are used to
18-
enqueue and dequeue messages.
17+
These objects are created using the :meth:`Connection.queue()` method and are
18+
used to enqueue and dequeue messages.
1919

2020
.. attribute:: Queue.connection
2121

@@ -82,9 +82,9 @@ Dequeue Options
8282

8383
.. note::
8484

85-
This object is an extension to the DB API. It is returned by the
86-
:meth:`Connection.deqoptions()` call and is used in calls to
87-
:meth:`Connection.deq()`.
85+
These objects are used to configure how messages are dequeued from queues.
86+
An instance of this object is found in the attribute
87+
:attr:`Queue.deqOptions`.
8888

8989

9090
.. attribute:: DeqOptions.condition
@@ -177,9 +177,9 @@ Enqueue Options
177177

178178
.. note::
179179

180-
This object is an extension to the DB API. It is returned by the
181-
:meth:`Connection.enqoptions()` call and is used in calls to
182-
:meth:`Connection.enq()`.
180+
These objects are used to configure how messages are enqueued into queues.
181+
An instance of this object is found in the attribute
182+
:attr:`Queue.enqOptions`.
183183

184184

185185
.. attribute:: EnqOptions.deliverymode
@@ -213,9 +213,11 @@ Message Properties
213213

214214
.. note::
215215

216-
This object is an extension to the DB API. It is returned by the
217-
:meth:`Connection.msgproperties()` call and is used in calls to
218-
:meth:`Connection.deq()` and :meth:`Connection.enq()`.
216+
These objects are used to identify the properties of messages that are
217+
enqueued and dequeued in queues. They are created by the method
218+
:meth:`Connection.msgproperties()`. They are used by the methods
219+
:meth:`Queue.enqOne()` and :meth:`Queue.enqMany()` and
220+
returned by the methods :meth:`Queue.deqOne()` and :meth:`Queue.deqMany()`.
219221

220222

221223
.. attribute:: MessageProperties.attempts

doc/src/connection.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,13 +407,19 @@ Connection Object
407407
This attribute is an extension to the DB API definition.
408408
409409
410-
.. method:: Connection.msgproperties()
410+
.. method:: Connection.msgproperties(payload, correlation, delay, exceptionq, \
411+
expiration, priority)
411412

412413
Returns an object specifying the properties of messages used in advanced
413414
queuing. See :ref:`msgproperties` for more information.
414415

416+
Each of the parameters are optional. If specified, they act as a shortcut
417+
for setting each of the equivalently named properties.
418+
415419
.. versionadded:: 5.3
416420

421+
.. versionchanged:: 7.2 Added parameters
422+
417423
.. note::
418424

419425
This method is an extension to the DB API definition.

src/cxoConnection.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1348,7 +1348,7 @@ static PyObject *cxoConnection_newMessageProperties(cxoConnection *conn,
13481348
PyObject *args, PyObject *keywordArgs)
13491349
{
13501350
static char *keywordList[] = { "payload", "correlation", "delay",
1351-
"exceptionQ", "expiration", "priority", NULL };
1351+
"exceptionq", "expiration", "priority", NULL };
13521352
PyObject *payloadObj, *correlationObj, *exceptionQObj;
13531353
int delay, expiration, priority, status;
13541354
cxoMsgProps *props;

0 commit comments

Comments
 (0)