| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Uses of Interface org.apache.qpid.protonj2.client.Session (Qpid ProtonJ2 Parent 1.0.0-M9 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="Uses of Interface org.apache.qpid.protonj2.client.Session (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Class</a></li> |
| <li class="navBarCell1Rev">Use</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> |
| <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> |
| <main role="main"> |
| <div class="header"> |
| <h2 title="Uses of Interface org.apache.qpid.protonj2.client.Session" class="title">Uses of Interface<br>org.apache.qpid.protonj2.client.Session</h2> |
| </div> |
| <div class="classUseContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="useSummary"> |
| <caption><span>Packages that use <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Package</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.qpid.protonj2.client">org.apache.qpid.protonj2.client</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="#org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.qpid.protonj2.client"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a></h3> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> that return <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span><span class="tabEnd"> </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> |
| <tbody> |
| <tr 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"><span class="typeNameLabel">Session.</span><code><span class="memberNameLink"><a href="../Session.html#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 class="rowColor"> |
| <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"><span class="typeNameLabel">Session.</span><code><span class="memberNameLink"><a href="../Session.html#commitTransaction()">commitTransaction</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Commit the currently active transaction in this Session.</div> |
| </td> |
| </tr> |
| <tr 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"><span class="typeNameLabel">Connection.</span><code><span class="memberNameLink"><a href="../Connection.html#defaultSession()">defaultSession</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the default <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance that is used by this Connection to |
| create the default anonymous connection <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> as well as creating those |
| resources created from the <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> such as <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 not married to a specific <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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"><span class="typeNameLabel">Connection.</span><code><span class="memberNameLink"><a href="../Connection.html#openSession()">openSession</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance for use by the client application.</div> |
| </td> |
| </tr> |
| <tr 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"><span class="typeNameLabel">Connection.</span><code><span class="memberNameLink"><a href="../Connection.html#openSession(org.apache.qpid.protonj2.client.SessionOptions)">openSession</a></span>​(<a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> options)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> instance for use by the client application.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <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"><span class="typeNameLabel">Session.</span><code><span class="memberNameLink"><a href="../Session.html#rollbackTransaction()">rollbackTransaction</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Roll back the currently active transaction in this Session.</div> |
| </td> |
| </tr> |
| <tr 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"><span class="typeNameLabel">Link.</span><code><span class="memberNameLink"><a href="../Link.html#session()">session</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> that return types with arguments of type <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span><span class="tabEnd"> </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> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Session.</span><code><span class="memberNameLink"><a href="../Session.html#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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be |
| completed once the session has been remotely closed or an error occurs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Session.</span><code><span class="memberNameLink"><a href="../Session.html#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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be |
| completed once the session has been remotely closed or an error occurs.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">Session.</span><code><span class="memberNameLink"><a href="../Session.html#openFuture()">openFuture</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section role="region"><a id="org.apache.qpid.protonj2.client.impl"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a> in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a></h3> |
| <table class="useSummary"> |
| <caption><span>Classes in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> that implement <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../impl/ClientSession.html" title="class in org.apache.qpid.protonj2.client.impl">ClientSession</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Client implementation of the Session API.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../impl/ClientStreamSession.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamSession</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">A specialized <a href="../impl/ClientSession.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientSession</code></a> that is the parent of a <a href="../impl/ClientStreamSender.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientStreamSender</code></a> or |
| <a href="../impl/ClientStreamReceiver.html" title="class in org.apache.qpid.protonj2.client.impl"><code>ClientStreamReceiver</code></a> and cannot create any further resources as the lifetime of the |
| session is tied to the child <a href="../StreamSender.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSender</code></a> or <a href="../StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> that return <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span><span class="tabEnd"> </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> |
| <tbody> |
| <tr 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"><span class="typeNameLabel">ClientSession.</span><code><span class="memberNameLink"><a href="../impl/ClientSession.html#beginTransaction()">beginTransaction</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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"><span class="typeNameLabel">ClientSession.</span><code><span class="memberNameLink"><a href="../impl/ClientSession.html#commitTransaction()">commitTransaction</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr 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"><span class="typeNameLabel">ClientConnection.</span><code><span class="memberNameLink"><a href="../impl/ClientConnection.html#defaultSession()">defaultSession</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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"><span class="typeNameLabel">ClientConnection.</span><code><span class="memberNameLink"><a href="../impl/ClientConnection.html#openSession()">openSession</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr 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"><span class="typeNameLabel">ClientConnection.</span><code><span class="memberNameLink"><a href="../impl/ClientConnection.html#openSession(org.apache.qpid.protonj2.client.SessionOptions)">openSession</a></span>​(<a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> sessionOptions)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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"><span class="typeNameLabel">ClientSession.</span><code><span class="memberNameLink"><a href="../impl/ClientSession.html#rollbackTransaction()">rollbackTransaction</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary"> |
| <caption><span>Methods in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> that return types with arguments of type <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span><span class="tabEnd"> </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> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ClientSession.</span><code><span class="memberNameLink"><a href="../impl/ClientSession.html#closeAsync()">closeAsync</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ClientSession.</span><code><span class="memberNameLink"><a href="../impl/ClientSession.html#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"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></td> |
| <th class="colSecond" scope="row"><span class="typeNameLabel">ClientSession.</span><code><span class="memberNameLink"><a href="../impl/ClientSession.html#openFuture()">openFuture</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </section> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <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><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Class</a></li> |
| <li class="navBarCell1Rev">Use</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> |
| <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> |