| <?xml version="1.0" encoding="ascii"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <title>proton._handlers.TransactionalClientHandler</title> |
| <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
| <script type="text/javascript" src="epydoc.js"></script> |
| </head> |
| |
| <body bgcolor="white" text="black" link="blue" vlink="#204080" |
| alink="#204080"> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| <!-- Home link --> |
| <th> <a |
| href="proton-module.html">Home</a> </th> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <!-- Project homepage --> |
| <th class="navbar" align="right" width="100%"> |
| <table border="0" cellpadding="0" cellspacing="0"> |
| <tr><th class="navbar" align="center" |
| ><a class="navbar" target="_top" href="http://qpid.apache.org/index.html">Qpid Proton Python API</a></th> |
| </tr></table></th> |
| </tr> |
| </table> |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr valign="top"> |
| <td width="100%"> |
| <span class="breadcrumbs"> |
| <a href="proton-module.html">Package proton</a> :: |
| <a href="proton._handlers-module.html" onclick="show_private();">Module _handlers</a> :: |
| Class TransactionalClientHandler |
| </span> |
| </td> |
| <td> |
| <table cellpadding="0" cellspacing="0"> |
| <!-- hide/show private --> |
| <tr><td align="right"><span class="options" |
| >[<a href="frames.html" target="_top">frames</a |
| >] | <a href="proton._handlers.TransactionalClientHandler-class.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== TYPE DESCRIPTION ==================== --> |
| <h1 class="epydoc">type TransactionalClientHandler</h1><p class="nomargin-top"><span class="codelink"><a href="proton._handlers-pysrc.html#TransactionalClientHandler">source code</a></span></p> |
| <center> |
| |
| </center> |
| <hr /> |
| <p>An extension to the MessagingHandler for applications using |
| transactions.</p> |
| |
| <!-- ==================== INSTANCE METHODS ==================== --> |
| <a name="section-InstanceMethods"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Instance Methods</span></td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton._handlers.TransactionalClientHandler-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">prefetch</span>=<span class="summary-sig-default">10</span>, |
| <span class="summary-sig-arg">auto_accept</span>=<span class="summary-sig-default">False</span>, |
| <span class="summary-sig-arg">auto_settle</span>=<span class="summary-sig-default">True</span>, |
| <span class="summary-sig-arg">peer_close_is_error</span>=<span class="summary-sig-default">False</span>)</span></td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._handlers-pysrc.html#TransactionalClientHandler.__init__">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="proton._handlers.TransactionalClientHandler-class.html#accept" class="summary-sig-name">accept</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">delivery</span>, |
| <span class="summary-sig-arg">transaction</span>=<span class="summary-sig-default">None</span>)</span><br /> |
| Accepts a received message.</td> |
| <td align="right" valign="top"> |
| <span class="codelink"><a href="proton._handlers-pysrc.html#TransactionalClientHandler.accept">source code</a></span> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td colspan="2" class="summary"> |
| <p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton._handlers.MessagingHandler-class.html">MessagingHandler</a></code></b>: |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_accepted">on_accepted</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_connection_closed">on_connection_closed</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_connection_closing">on_connection_closing</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_connection_error">on_connection_error</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_disconnected">on_disconnected</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_link_closed">on_link_closed</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_link_closing">on_link_closing</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_link_error">on_link_error</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_message">on_message</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_reactor_init">on_reactor_init</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_rejected">on_rejected</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_released">on_released</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_sendable">on_sendable</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_session_closed">on_session_closed</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_session_closing">on_session_closing</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_session_error">on_session_error</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_settled">on_settled</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_start">on_start</a></code>, |
| <code><a href="proton._handlers.MessagingHandler-class.html#on_transport_error">on_transport_error</a></code> |
| </p> |
| <p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton._events.Handler-class.html">_events.Handler</a></code></b>: |
| <code><a href="proton._events.Handler-class.html#handlers">handlers</a></code>, |
| <code><a href="proton._events.Handler-class.html#on_unhandled">on_unhandled</a></code> |
| </p> |
| <p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton._handlers.Acking-class.html">Acking</a></code></b>: |
| <code><a href="proton._handlers.Acking-class.html#reject">reject</a></code>, |
| <code><a href="proton._handlers.Acking-class.html#release">release</a></code>, |
| <code><a href="proton._handlers.Acking-class.html#settle">settle</a></code> |
| </p> |
| <p class="indent-wrapped-lines"><b>Inherited from <code><a href="proton._handlers.TransactionHandler-class.html">TransactionHandler</a></code></b>: |
| <code><a href="proton._handlers.TransactionHandler-class.html#on_transaction_aborted">on_transaction_aborted</a></code>, |
| <code><a href="proton._handlers.TransactionHandler-class.html#on_transaction_commit_failed">on_transaction_commit_failed</a></code>, |
| <code><a href="proton._handlers.TransactionHandler-class.html#on_transaction_committed">on_transaction_committed</a></code>, |
| <code><a href="proton._handlers.TransactionHandler-class.html#on_transaction_declare_failed">on_transaction_declare_failed</a></code>, |
| <code><a href="proton._handlers.TransactionHandler-class.html#on_transaction_declared">on_transaction_declared</a></code> |
| </p> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== METHOD DETAILS ==================== --> |
| <a name="section-MethodDetails"></a> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td align="left" colspan="2" class="table-header"> |
| <span class="table-header">Method Details</span></td> |
| </tr> |
| </table> |
| <a name="__init__"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">prefetch</span>=<span class="sig-default">10</span>, |
| <span class="sig-arg">auto_accept</span>=<span class="sig-default">False</span>, |
| <span class="sig-arg">auto_settle</span>=<span class="sig-default">True</span>, |
| <span class="sig-arg">peer_close_is_error</span>=<span class="sig-default">False</span>)</span> |
| <br /><em class="fname">(Constructor)</em> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton._handlers-pysrc.html#TransactionalClientHandler.__init__">source code</a></span> |
| </td> |
| </tr></table> |
| |
| |
| <dl class="fields"> |
| <dt>Overrides: |
| <a href="proton._handlers.MessagingHandler-class.html#__init__">MessagingHandler.__init__</a> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <a name="accept"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">accept</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">delivery</span>, |
| <span class="sig-arg">transaction</span>=<span class="sig-default">None</span>)</span> |
| </h3> |
| </td><td align="right" valign="top" |
| ><span class="codelink"><a href="proton._handlers-pysrc.html#TransactionalClientHandler.accept">source code</a></span> |
| </td> |
| </tr></table> |
| |
| <p>Accepts a received message.</p> |
| <p>Note that this method cannot currently be used in combination with |
| transactions.</p> |
| <dl class="fields"> |
| <dt>Overrides: |
| <a href="proton._handlers.Acking-class.html#accept">Acking.accept</a> |
| <dd><em class="note">(inherited documentation)</em></dd> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <br /> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| <!-- Home link --> |
| <th> <a |
| href="proton-module.html">Home</a> </th> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <!-- Project homepage --> |
| <th class="navbar" align="right" width="100%"> |
| <table border="0" cellpadding="0" cellspacing="0"> |
| <tr><th class="navbar" align="center" |
| ><a class="navbar" target="_top" href="http://qpid.apache.org/index.html">Qpid Proton Python API</a></th> |
| </tr></table></th> |
| </tr> |
| </table> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| <tr> |
| <td align="left" class="footer"> |
| Generated by Epydoc 3.0.1 |
| </td> |
| <td align="right" class="footer"> |
| <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| >http://epydoc.sourceforge.net</a> |
| </td> |
| </tr> |
| </table> |
| |
| <script type="text/javascript"> |
| <!-- |
| // Private objects are initially displayed (because if |
| // javascript is turned off then we want them to be |
| // visible); but by default, we want to hide them. So hide |
| // them unless we have a cookie that says to show them. |
| checkCookie(); |
| // --> |
| </script> |
| </body> |
| </html> |
