diff --git a/doc/src/aq.rst b/doc/src/aq.rst index 4770f6c..fe99f12 100644 --- a/doc/src/aq.rst +++ b/doc/src/aq.rst @@ -14,8 +14,8 @@ Advanced Queuing Queues ------ -Queues are created using the :meth:`Connection.queue()` method and are used to -enqueue and dequeue messages. +These objects are created using the :meth:`Connection.queue()` method and are +used to enqueue and dequeue messages. .. attribute:: Queue.connection @@ -82,9 +82,9 @@ Dequeue Options .. note:: - This object is an extension to the DB API. It is returned by the - :meth:`Connection.deqoptions()` call and is used in calls to - :meth:`Connection.deq()`. + These objects are used to configure how messages are dequeued from queues. + An instance of this object is found in the attribute + :attr:`Queue.deqOptions`. .. attribute:: DeqOptions.condition @@ -177,9 +177,9 @@ Enqueue Options .. note:: - This object is an extension to the DB API. It is returned by the - :meth:`Connection.enqoptions()` call and is used in calls to - :meth:`Connection.enq()`. + These objects are used to configure how messages are enqueued into queues. + An instance of this object is found in the attribute + :attr:`Queue.enqOptions`. .. attribute:: EnqOptions.deliverymode @@ -213,9 +213,11 @@ Message Properties .. note:: - This object is an extension to the DB API. It is returned by the - :meth:`Connection.msgproperties()` call and is used in calls to - :meth:`Connection.deq()` and :meth:`Connection.enq()`. + These objects are used to identify the properties of messages that are + enqueued and dequeued in queues. They are created by the method + :meth:`Connection.msgproperties()`. They are used by the methods + :meth:`Queue.enqOne()` and :meth:`Queue.enqMany()` and + returned by the methods :meth:`Queue.deqOne()` and :meth:`Queue.deqMany()`. .. attribute:: MessageProperties.attempts diff --git a/doc/src/connection.rst b/doc/src/connection.rst index 56e2c7c..e830641 100644 --- a/doc/src/connection.rst +++ b/doc/src/connection.rst @@ -407,13 +407,19 @@ Connection Object This attribute is an extension to the DB API definition. -.. method:: Connection.msgproperties() +.. method:: Connection.msgproperties(payload, correlation, delay, exceptionq, \ + expiration, priority) Returns an object specifying the properties of messages used in advanced queuing. See :ref:`msgproperties` for more information. + Each of the parameters are optional. If specified, they act as a shortcut + for setting each of the equivalently named properties. + .. versionadded:: 5.3 + .. versionchanged:: 7.2 Added parameters + .. note:: This method is an extension to the DB API definition. diff --git a/src/cxoConnection.c b/src/cxoConnection.c index 9f2e24b..e77e8e2 100644 --- a/src/cxoConnection.c +++ b/src/cxoConnection.c @@ -1348,7 +1348,7 @@ static PyObject *cxoConnection_newMessageProperties(cxoConnection *conn, PyObject *args, PyObject *keywordArgs) { static char *keywordList[] = { "payload", "correlation", "delay", - "exceptionQ", "expiration", "priority", NULL }; + "exceptionq", "expiration", "priority", NULL }; PyObject *payloadObj, *correlationObj, *exceptionQObj; int delay, expiration, priority, status; cxoMsgProps *props;