| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Session (Qpid ProtonJ2 Parent 1.0.0-M2 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Session (Qpid ProtonJ2 Parent 1.0.0-M2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Session.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.client</a></div> |
| <h2 title="Interface Session" class="title">Interface Session</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>java.lang.AutoCloseable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/ClientSession.html" title="class in org.apache.qpid.protonj2.client.impl">ClientSession</a></code>, <code><a href="impl/ClientStreamSession.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamSession</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Session</span> |
| extends java.lang.AutoCloseable</pre> |
| <div class="block">Session object used to create <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> and <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instances.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beginTransaction()">beginTransaction</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Opens a new transaction scoped to this <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> if one is not already active.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#client()">client</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Requests a close of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> at the remote and waits until the Session has been |
| fully closed or until the configured <a href="SessionOptions.html#closeTimeout()"><code>SessionOptions.closeTimeout()</code></a> is exceeded.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(org.apache.qpid.protonj2.client.ErrorCondition)">close</a></span>​(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</code></th> |
| <td class="colLast"> |
| <div class="block">Requests a close of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> at the remote and waits until the Session has been |
| fully closed or until the configured <a href="SessionOptions.html#closeTimeout()"><code>SessionOptions.closeTimeout()</code></a> is exceeded.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeAsync()">closeAsync</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Requests a close of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> at the remote and returns a <code>Future</code> that will be |
| completed once the session has been remotely closed or an error occurs.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a></span>​(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</code></th> |
| <td class="colLast"> |
| <div class="block">Requests a close of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> at the remote and returns a <code>Future</code> that will be |
| completed once the session has been remotely closed or an error occurs.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commitTransaction()">commitTransaction</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Commit the currently active transaction in this Session.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connection()">connection</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#desiredCapabilities()">desiredCapabilities</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the desired capabilities that the remote provided upon successfully opening the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offeredCapabilities()">offeredCapabilities</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the offered capabilities that the remote provided upon successfully opening the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openAnonymousSender()">openAnonymousSender</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a sender that is established to the 'anonymous relay' and as such each |
| message that is sent using this sender must specify an address in its destination |
| address field.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openAnonymousSender(org.apache.qpid.protonj2.client.SenderOptions)">openAnonymousSender</a></span>​(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a sender that is established to the 'anonymous relay' and as such each |
| message that is sent using this sender must specify an address in its destination |
| address field.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDurableReceiver(java.lang.String,java.lang.String)">openDurableReceiver</a></span>​(java.lang.String address, |
| java.lang.String subscriptionName)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a receiver used to consume messages from the given node address and configure it |
| such that the remote create a durable node.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDurableReceiver(java.lang.String,java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)">openDurableReceiver</a></span>​(java.lang.String address, |
| java.lang.String subscriptionName, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a receiver used to consume messages from the given node address and configure it |
| such that the remote create a durable node.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDynamicReceiver()">openDynamicReceiver</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDynamicReceiver(java.util.Map)">openDynamicReceiver</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> dynamicNodeProperties)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDynamicReceiver(java.util.Map,org.apache.qpid.protonj2.client.ReceiverOptions)">openDynamicReceiver</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> dynamicNodeProperties, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDynamicReceiver(org.apache.qpid.protonj2.client.ReceiverOptions)">openDynamicReceiver</a></span>​(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openFuture()">openFuture</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openReceiver(java.lang.String)">openReceiver</a></span>​(java.lang.String address)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openReceiver(java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)">openReceiver</a></span>​(java.lang.String address, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a receiver used to consume messages from the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openSender(java.lang.String)">openSender</a></span>​(java.lang.String address)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a sender used to send messages to the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openSender(java.lang.String,org.apache.qpid.protonj2.client.SenderOptions)">openSender</a></span>​(java.lang.String address, |
| <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a sender used to send messages to the given node address.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.lang.Object></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties()">properties</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the properties that the remote provided upon successfully opening the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rollbackTransaction()">rollbackTransaction</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Roll back the currently active transaction in this Session.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="client()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>client</h4> |
| <pre class="methodSignature"><a href="Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a> client()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> instance that holds this session's <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="connection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connection</h4> |
| <pre class="methodSignature"><a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a> connection()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> that created and holds this <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openFuture()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openFuture</h4> |
| <pre class="methodSignature">java.util.concurrent.Future<<a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>> openFuture()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Future</code> that will be completed when the remote opens this <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close()</pre> |
| <div class="block">Requests a close of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> at the remote and waits until the Session has been |
| fully closed or until the configured <a href="SessionOptions.html#closeTimeout()"><code>SessionOptions.closeTimeout()</code></a> is exceeded.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close(org.apache.qpid.protonj2.client.ErrorCondition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">void close​(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</pre> |
| <div class="block">Requests a close of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> at the remote and waits until the Session has been |
| fully closed or until the configured <a href="SessionOptions.html#closeTimeout()"><code>SessionOptions.closeTimeout()</code></a> is exceeded.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the close operation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="closeAsync()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeAsync</h4> |
| <pre class="methodSignature">java.util.concurrent.Future<<a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>> closeAsync()</pre> |
| <div class="block">Requests a close of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> at the remote and returns a <code>Future</code> that will be |
| completed once the session has been remotely closed or an error occurs.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Future</code> that will be completed when the remote closes this <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeAsync</h4> |
| <pre class="methodSignature">java.util.concurrent.Future<<a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>> closeAsync​(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</pre> |
| <div class="block">Requests a close of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> at the remote and returns a <code>Future</code> that will be |
| completed once the session has been remotely closed or an error occurs.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the close operation.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>Future</code> that will be completed when the remote closes this <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openReceiver(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openReceiver</h4> |
| <pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openReceiver​(java.lang.String address) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a receiver used to consume messages from the given node address.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openReceiver(java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openReceiver</h4> |
| <pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openReceiver​(java.lang.String address, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a receiver used to consume messages from the given node address.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDurableReceiver(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDurableReceiver</h4> |
| <pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDurableReceiver​(java.lang.String address, |
| java.lang.String subscriptionName) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a receiver used to consume messages from the given node address and configure it |
| such that the remote create a durable node.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dd><code>subscriptionName</code> - The name to give the subscription (link name).</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDurableReceiver(java.lang.String,java.lang.String,org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDurableReceiver</h4> |
| <pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDurableReceiver​(java.lang.String address, |
| java.lang.String subscriptionName, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a receiver used to consume messages from the given node address and configure it |
| such that the remote create a durable node.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The source address to attach the consumer to.</dd> |
| <dd><code>subscriptionName</code> - The name to give the subscription (link name).</dd> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDynamicReceiver()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDynamicReceiver</h4> |
| <pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDynamicReceiver() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDynamicReceiver(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDynamicReceiver</h4> |
| <pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDynamicReceiver​(java.util.Map<java.lang.String,​java.lang.Object> dynamicNodeProperties) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dynamicNodeProperties</code> - The dynamic node properties to be applied to the node created by the remote.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDynamicReceiver(org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDynamicReceiver</h4> |
| <pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDynamicReceiver​(<a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openDynamicReceiver(java.util.Map,org.apache.qpid.protonj2.client.ReceiverOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openDynamicReceiver</h4> |
| <pre class="methodSignature"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a> openDynamicReceiver​(java.util.Map<java.lang.String,​java.lang.Object> dynamicNodeProperties, |
| <a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a> receiverOptions) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a dynamic receiver used to consume messages from the given node address.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dynamicNodeProperties</code> - The dynamic node properties to be applied to the node created by the remote.</dd> |
| <dd><code>receiverOptions</code> - The options for this receiver.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openSender(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openSender</h4> |
| <pre class="methodSignature"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a> openSender​(java.lang.String address) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a sender used to send messages to the given node address. If no |
| address (i.e null) is specified then a sender will be established to the |
| 'anonymous relay' and each message must specify its destination address.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The target address to attach to, or null to attach to the |
| anonymous relay.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openSender(java.lang.String,org.apache.qpid.protonj2.client.SenderOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openSender</h4> |
| <pre class="methodSignature"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a> openSender​(java.lang.String address, |
| <a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a sender used to send messages to the given node address. If no |
| address (i.e null) is specified then a sender will be established to the |
| 'anonymous relay' and each message must specify its destination address.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>address</code> - The target address to attach to, or null to attach to the |
| anonymous relay.</dd> |
| <dd><code>senderOptions</code> - The options for this sender.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openAnonymousSender()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openAnonymousSender</h4> |
| <pre class="methodSignature"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a> openAnonymousSender() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a sender that is established to the 'anonymous relay' and as such each |
| message that is sent using this sender must specify an address in its destination |
| address field.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| <dd><code><a href="exceptions/ClientUnsupportedOperationException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientUnsupportedOperationException</a></code> - if the remote did not signal support for anonymous relays.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openAnonymousSender(org.apache.qpid.protonj2.client.SenderOptions)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openAnonymousSender</h4> |
| <pre class="methodSignature"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a> openAnonymousSender​(<a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a> senderOptions) |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Creates a sender that is established to the 'anonymous relay' and as such each |
| message that is sent using this sender must specify an address in its destination |
| address field.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>senderOptions</code> - The options for this sender.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the newly created <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an internal error occurs.</dd> |
| <dd><code><a href="exceptions/ClientUnsupportedOperationException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientUnsupportedOperationException</a></code> - if the remote did not signal support for anonymous relays.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="properties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>properties</h4> |
| <pre class="methodSignature">java.util.Map<java.lang.String,​java.lang.Object> properties() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Returns the properties that the remote provided upon successfully opening the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>. If the |
| open has not completed yet this method will block to await the open response which carries the remote |
| properties. If the remote provides no properties this method will return null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>any properties provided from the remote once the session has successfully opened.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> remote properties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="offeredCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>offeredCapabilities</h4> |
| <pre class="methodSignature">java.lang.String[] offeredCapabilities() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Returns the offered capabilities that the remote provided upon successfully opening the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>. |
| If the open has not completed yet this method will block to await the open response which carries the |
| remote offered capabilities. If the remote provides no capabilities this method will return null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>any capabilities provided from the remote once the session has successfully opened.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> remote offered capabilities.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="desiredCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>desiredCapabilities</h4> |
| <pre class="methodSignature">java.lang.String[] desiredCapabilities() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Returns the desired capabilities that the remote provided upon successfully opening the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>. |
| If the open has not completed yet this method will block to await the open response which carries the |
| remote desired capabilities. If the remote provides no capabilities this method will return null.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>any desired capabilities provided from the remote once the session has successfully opened.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> remote desired capabilities.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="beginTransaction()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginTransaction</h4> |
| <pre class="methodSignature"><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a> beginTransaction() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Opens a new transaction scoped to this <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> if one is not already active. |
| |
| A <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> that has an active transaction will perform all sends and all delivery dispositions |
| under that active transaction. If the user wishes to send with the same session but outside of a |
| transaction they user must commit the active transaction and not request that a new one be started. |
| A session can only have one active transaction at a time and as such any call to begin while there is |
| a currently active transaction will throw an <a href="exceptions/ClientTransactionNotActiveException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientTransactionNotActiveException</code></a> to indicate that |
| the operation being requested is not valid at that time. |
| |
| This is a blocking method that will return successfully only after a new transaction has been started.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while attempting to begin a new transaction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="commitTransaction()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>commitTransaction</h4> |
| <pre class="methodSignature"><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a> commitTransaction() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Commit the currently active transaction in this Session. |
| |
| Commit the currently active transaction in this Session but does not start a new transaction |
| automatically. If there is no current transaction this method will throw an <a href="exceptions/ClientTransactionNotActiveException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientTransactionNotActiveException</code></a> |
| to indicate this error. If the active transaction has entered an in doubt state or was remotely rolled |
| back this method will throw an error to indicate that the commit failed and that a new transaction |
| need to be started by the user. When a transaction rolled back error occurs the user should assume that |
| all work performed under that transaction has failed and will need to be attempted under a new transaction. |
| |
| This is a blocking method that will return successfully only after the current transaction has been committed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while attempting to commit the current transaction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="rollbackTransaction()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>rollbackTransaction</h4> |
| <pre class="methodSignature"><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a> rollbackTransaction() |
| throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre> |
| <div class="block">Roll back the currently active transaction in this Session. |
| |
| Roll back the currently active transaction in this Session but does not automatically start a new |
| transaction. If there is no current transaction this method will throw an <a href="exceptions/ClientTransactionNotActiveException.html" title="class in org.apache.qpid.protonj2.client.exceptions"><code>ClientTransactionNotActiveException</code></a> |
| to indicate this error. If the active transaction has entered an in doubt state or was remotely rolled |
| back this method will throw an error to indicate that the roll back failed and that a new transaction need |
| to be started by the user.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while attempting to roll back the current transaction.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Session.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |