Google Git
Sign in
apache / activemq-website / 254c925c8b9c5da093d15047d12a2037ed564fcb / . / src / components / cms / api_docs / activemqcpp-3.4.0 / html / classactivemq_1_1core_1_1_active_m_q_x_a_session.html
blob: d35b0f476d25625c7025987ffdf6f856f36e8391 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>activemq-cpp-3.4.0: activemq::core::ActiveMQXASession Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">activemq-cpp-3.4.0</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classactivemq_1_1core_1_1_active_m_q_x_a_session.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>activemq::core::ActiveMQXASession Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="activemq::core::ActiveMQXASession" --><!-- doxytag: inherits="cms::XASession,activemq::core::ActiveMQSession" -->
<p><code>#include &lt;<a class="el" href="_active_m_q_x_a_session_8h_source.html">src/main/activemq/core/ActiveMQXASession.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for activemq::core::ActiveMQXASession:</div>
<div class="dyncontent">
<div class="center"><img src="classactivemq_1_1core_1_1_active_m_q_x_a_session__inherit__graph.png" border="0" usemap="#activemq_1_1core_1_1_active_m_q_x_a_session_inherit__map" alt="Inheritance graph"/></div>
<map name="activemq_1_1core_1_1_active_m_q_x_a_session_inherit__map" id="activemq_1_1core_1_1_active_m_q_x_a_session_inherit__map">
<area shape="rect" id="node2" href="classcms_1_1_x_a_session.html" title="The XASession interface extends the capability of Session by adding access to a CMS provider&#39;s su..." alt="" coords="283,160,411,189"/><area shape="rect" id="node4" href="classcms_1_1_session.html" title="A Session object is a single&#45;threaded context for producing and consuming messages." alt="" coords="276,83,385,112"/><area shape="rect" id="node12" href="classactivemq_1_1core_1_1_active_m_q_session.html" title="activemq::core::ActiveMQSession" alt="" coords="5,160,259,189"/><area shape="rect" id="node6" href="classcms_1_1_closeable.html" title="Interface for a class that implements the close method." alt="" coords="120,5,245,35"/><area shape="rect" id="node8" href="classcms_1_1_startable.html" title="Interface for a class that implements the start method." alt="" coords="269,5,392,35"/><area shape="rect" id="node10" href="classcms_1_1_stoppable.html" title="Interface for a class that implements the stop method." alt="" coords="416,5,541,35"/><area shape="rect" id="node15" href="classactivemq_1_1core_1_1_dispatcher.html" title="Interface for an object responsible for dispatching messages to consumers." alt="" coords="27,83,237,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_x_a_session.html#a22f01066e8dd839cd9734b449de9c6ec">ActiveMQXASession</a> (<a class="el" href="classactivemq_1_1core_1_1_active_m_q_connection.html">ActiveMQConnection</a> *<a class="el" href="classactivemq_1_1core_1_1_active_m_q_session.html#a1fce73cdf30be5aca523a40505f805c3">connection</a>, const <a class="el" href="classdecaf_1_1lang_1_1_pointer.html">Pointer</a>&lt; <a class="el" href="classactivemq_1_1commands_1_1_session_id.html">commands::SessionId</a> &gt; &amp;sessionId, const <a class="el" href="classdecaf_1_1util_1_1_properties.html">decaf::util::Properties</a> &amp;properties)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_x_a_session.html#ab29c76b2c706b2da8982dcf76de5438e">~ActiveMQXASession</a> () throw ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_x_a_session.html#aa695cc050c91000e6543ca327ea7777c">isTransacted</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets if the Sessions is a Transacted Session. <a href="#aa695cc050c91000e6543ca327ea7777c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_x_a_session.html#ada1885e906a06b5022d2ebb961454a43">isAutoAcknowledge</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_x_a_session.html#a04375caecc0d3c8d3b9b0b5cb9150c0d">doStartTransaction</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts if not already start a Transaction for this Session. <a href="#a04375caecc0d3c8d3b9b0b5cb9150c0d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_x_a_session.html#aff2c7ac6583e7e515ed2e2f255f8e858">commit</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Commits all messages done in this transaction and releases any locks currently held. <a href="#aff2c7ac6583e7e515ed2e2f255f8e858"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_x_a_session.html#a15d991c5728adba7df6efcd4de4e7670">rollback</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Rolls back all messages done in this transaction and releases any locks currently held. <a href="#a15d991c5728adba7df6efcd4de4e7670"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classcms_1_1_x_a_resource.html">cms::XAResource</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_x_a_session.html#ad97ec41bb67adb882d4c6af29e282671">getXAResource</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the XA resource associated with this Session to the caller. <a href="#ad97ec41bb67adb882d4c6af29e282671"></a><br/></td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a22f01066e8dd839cd9734b449de9c6ec"></a><!-- doxytag: member="activemq::core::ActiveMQXASession::ActiveMQXASession" ref="a22f01066e8dd839cd9734b449de9c6ec" args="(ActiveMQConnection *connection, const Pointer&lt; commands::SessionId &gt; &amp;sessionId, const decaf::util::Properties &amp;properties)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">activemq::core::ActiveMQXASession::ActiveMQXASession </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_connection.html">ActiveMQConnection</a> *&#160;</td>
<td class="paramname"><em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classdecaf_1_1lang_1_1_pointer.html">Pointer</a>&lt; <a class="el" href="classactivemq_1_1commands_1_1_session_id.html">commands::SessionId</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>sessionId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classdecaf_1_1util_1_1_properties.html">decaf::util::Properties</a> &amp;&#160;</td>
<td class="paramname"><em>properties</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab29c76b2c706b2da8982dcf76de5438e"></a><!-- doxytag: member="activemq::core::ActiveMQXASession::~ActiveMQXASession" ref="ab29c76b2c706b2da8982dcf76de5438e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual activemq::core::ActiveMQXASession::~ActiveMQXASession </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> throw ()<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aff2c7ac6583e7e515ed2e2f255f8e858"></a><!-- doxytag: member="activemq::core::ActiveMQXASession::commit" ref="aff2c7ac6583e7e515ed2e2f255f8e858" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void activemq::core::ActiveMQXASession::commit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Commits all messages done in this transaction and releases any locks currently held. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">CMSException</td><td>- If an internal error occurs. </td></tr>
<tr><td class="paramname">IllegalStateException</td><td>- if the method is not called by a transacted session. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classactivemq_1_1core_1_1_active_m_q_session.html#ad407cb37b79c994fbc3a1b1a14ec844c">activemq::core::ActiveMQSession</a>.</p>
</div>
</div>
<a class="anchor" id="a04375caecc0d3c8d3b9b0b5cb9150c0d"></a><!-- doxytag: member="activemq::core::ActiveMQXASession::doStartTransaction" ref="a04375caecc0d3c8d3b9b0b5cb9150c0d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void activemq::core::ActiveMQXASession::doStartTransaction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Starts if not already start a Transaction for this Session. </p>
<p>If the session is not a Transacted Session then an exception is thrown. If a transaction is already in progress then this method has no effect.</p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">ActiveMQException</td><td>if this is not a Transacted Session. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classactivemq_1_1core_1_1_active_m_q_session.html#acf3a0d080c79008abd91447134343519">activemq::core::ActiveMQSession</a>.</p>
</div>
</div>
<a class="anchor" id="ad97ec41bb67adb882d4c6af29e282671"></a><!-- doxytag: member="activemq::core::ActiveMQXASession::getXAResource" ref="ad97ec41bb67adb882d4c6af29e282671" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcms_1_1_x_a_resource.html">cms::XAResource</a>* activemq::core::ActiveMQXASession::getXAResource </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the XA resource associated with this Session to the caller. </p>
<p>The client can use the provided XA resource to interact with the XA Transaction Manager in use in the client application.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>an XAResouce instance to the caller, the caller does not own this pointer and should not delete it. </dd></dl>
<p>Implements <a class="el" href="classcms_1_1_x_a_session.html#a4e0759c7cece2b9fe612a5159d2d88ec">cms::XASession</a>.</p>
</div>
</div>
<a class="anchor" id="ada1885e906a06b5022d2ebb961454a43"></a><!-- doxytag: member="activemq::core::ActiveMQXASession::isAutoAcknowledge" ref="ada1885e906a06b5022d2ebb961454a43" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool activemq::core::ActiveMQXASession::isAutoAcknowledge </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classactivemq_1_1core_1_1_active_m_q_session.html#ad4ed70660d19670c781ffefcfb73c798">activemq::core::ActiveMQSession</a>.</p>
</div>
</div>
<a class="anchor" id="aa695cc050c91000e6543ca327ea7777c"></a><!-- doxytag: member="activemq::core::ActiveMQXASession::isTransacted" ref="aa695cc050c91000e6543ca327ea7777c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool activemq::core::ActiveMQXASession::isTransacted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets if the Sessions is a Transacted Session. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>transacted true - false.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">CMSException</td><td>- If an internal error occurs. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classactivemq_1_1core_1_1_active_m_q_session.html#a96d9a9b094e318ea4d12c4910b3c5fb4">activemq::core::ActiveMQSession</a>.</p>
</div>
</div>
<a class="anchor" id="a15d991c5728adba7df6efcd4de4e7670"></a><!-- doxytag: member="activemq::core::ActiveMQXASession::rollback" ref="a15d991c5728adba7df6efcd4de4e7670" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void activemq::core::ActiveMQXASession::rollback </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Rolls back all messages done in this transaction and releases any locks currently held. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">CMSException</td><td>- If an internal error occurs. </td></tr>
<tr><td class="paramname">IllegalStateException</td><td>- if the method is not called by a transacted session. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented from <a class="el" href="classactivemq_1_1core_1_1_active_m_q_session.html#a9f227aa9bfb3f133b2ae363f75f9061a">activemq::core::ActiveMQSession</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/main/activemq/core/<a class="el" href="_active_m_q_x_a_session_8h_source.html">ActiveMQXASession.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceactivemq.html">activemq</a> </li>
<li class="navelem"><a class="el" href="namespaceactivemq_1_1core.html">core</a> </li>
<li class="navelem"><a class="el" href="classactivemq_1_1core_1_1_active_m_q_x_a_session.html">ActiveMQXASession</a> </li>
<li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>