HackBase/python-cx_Oracle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adjusted documentation to follow new API.

Browse Source
This commit is contained in:
Anthony Tuininga 2019-06-19 16:02:34 -06:00
parent 5f8d24dd24
commit e6a825db27
3 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/src/aq.rst
View File

@ -14,8 +14,8 @@ Advanced Queuing
Queues Queues
------ ------
Queues are created using the :meth:`Connection.queue()` method and are used to These objects are created using the :meth:`Connection.queue()` method and are
enqueue and dequeue messages. used to enqueue and dequeue messages.
.. attribute:: Queue.connection .. attribute:: Queue.connection
@ -82,9 +82,9 @@ Dequeue Options
.. note:: .. note::
This object is an extension to the DB API. It is returned by the These objects are used to configure how messages are dequeued from queues.
:meth:`Connection.deqoptions()` call and is used in calls to An instance of this object is found in the attribute
:meth:`Connection.deq()`. :attr:`Queue.deqOptions`.
.. attribute:: DeqOptions.condition .. attribute:: DeqOptions.condition
@ -177,9 +177,9 @@ Enqueue Options
.. note:: .. note::
This object is an extension to the DB API. It is returned by the These objects are used to configure how messages are enqueued into queues.
:meth:`Connection.enqoptions()` call and is used in calls to An instance of this object is found in the attribute
:meth:`Connection.enq()`. :attr:`Queue.enqOptions`.
.. attribute:: EnqOptions.deliverymode .. attribute:: EnqOptions.deliverymode
@ -213,9 +213,11 @@ Message Properties
.. note:: .. note::
This object is an extension to the DB API. It is returned by the These objects are used to identify the properties of messages that are
:meth:`Connection.msgproperties()` call and is used in calls to enqueued and dequeued in queues. They are created by the method
:meth:`Connection.deq()` and :meth:`Connection.enq()`. :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 .. attribute:: MessageProperties.attempts

8
doc/src/connection.rst
View File

@ -407,13 +407,19 @@ Connection Object
This attribute is an extension to the DB API definition. 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 Returns an object specifying the properties of messages used in advanced
queuing. See :ref:`msgproperties` for more information. 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 .. versionadded:: 5.3
.. versionchanged:: 7.2 Added parameters
.. note:: .. note::
This method is an extension to the DB API definition. This method is an extension to the DB API definition.

2
src/cxoConnection.c
View File

@ -1348,7 +1348,7 @@ static PyObject *cxoConnection_newMessageProperties(cxoConnection *conn,
PyObject *args, PyObject *keywordArgs) PyObject *args, PyObject *keywordArgs)
{ {
static char *keywordList[] = { "payload", "correlation", "delay", static char *keywordList[] = { "payload", "correlation", "delay",
"exceptionQ", "expiration", "priority", NULL }; "exceptionq", "expiration", "priority", NULL };
PyObject *payloadObj, *correlationObj, *exceptionQObj; PyObject *payloadObj, *correlationObj, *exceptionQObj;
int delay, expiration, priority, status; int delay, expiration, priority, status;
cxoMsgProps *props; cxoMsgProps *props;