| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Uses of Interface org.apache.qpid.protonj2.client.Session (Qpid ProtonJ2 Parent 1.0.0-M18 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="use: package: org.apache.qpid.protonj2.client, interface: Session"> |
| <meta name="generator" content="javadoc/ClassUseWriter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body class="class-use-page"> |
| <script type="text/javascript"></script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" 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="nav-bar-cell1-rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../help-doc.html#use">Help</a></li> |
| </ul> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Uses of Interface org.apache.qpid.protonj2.client.Session" class="title">Uses of Interface<br>org.apache.qpid.protonj2.client.Session</h1> |
| </div> |
| <div class="caption"><span>Packages that use <a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="#org.apache.qpid.protonj2.client">org.apache.qpid.protonj2.client</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="#org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl</a></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <section class="class-uses"> |
| <ul class="block-list"> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.client"> |
| <h2>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></h2> |
| <div class="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></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">Session.</span><code><a href="../Session.html#beginTransaction()" class="member-name-link">beginTransaction</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">Session.</span><code><a href="../Session.html#commitTransaction()" class="member-name-link">commitTransaction</a>()</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Commit the currently active transaction in this Session.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#defaultSession()" class="member-name-link">defaultSession</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#openSession()" class="member-name-link">openSession</a>()</code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#openSession(org.apache.qpid.protonj2.client.SessionOptions)" class="member-name-link">openSession</a><wbr>(<a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> options)</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">Session.</span><code><a href="../Session.html#rollbackTransaction()" class="member-name-link">rollbackTransaction</a>()</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Roll back the currently active transaction in this Session.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">Link.</span><code><a href="../Link.html#session()" class="member-name-link">session</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="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></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">Session.</span><code><a href="../Session.html#closeAsync()" class="member-name-link">closeAsync</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <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" title="class or interface in java.util.concurrent" class="external-link"><code>Future</code></a> that will be |
| completed once the session has been remotely closed or an error occurs.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">Session.</span><code><a href="../Session.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)" class="member-name-link">closeAsync</a><wbr>(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</code></div> |
| <div class="col-last odd-row-color"> |
| <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" title="class or interface in java.util.concurrent" class="external-link"><code>Future</code></a> that will be |
| completed once the session has been remotely closed or an error occurs.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">Session.</span><code><a href="../Session.html#openFuture()" class="member-name-link">openFuture</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="org.apache.qpid.protonj2.client.impl"> |
| <h2>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></h2> |
| <div class="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></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>class </code></div> |
| <div class="col-second even-row-color"><code><a href="../impl/ClientSession.html" class="type-name-link" title="class in org.apache.qpid.protonj2.client.impl">ClientSession</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Client implementation of the Session API.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>final class </code></div> |
| <div class="col-second odd-row-color"><code><a href="../impl/ClientStreamSession.html" class="type-name-link" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamSession</a></code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| </div> |
| <div class="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></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ClientSession.</span><code><a href="../impl/ClientSession.html#beginTransaction()" class="member-name-link">beginTransaction</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ClientSession.</span><code><a href="../impl/ClientSession.html#commitTransaction()" class="member-name-link">commitTransaction</a>()</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ClientConnection.</span><code><a href="../impl/ClientConnection.html#defaultSession()" class="member-name-link">defaultSession</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ClientConnection.</span><code><a href="../impl/ClientConnection.html#openSession()" class="member-name-link">openSession</a>()</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ClientConnection.</span><code><a href="../impl/ClientConnection.html#openSession(org.apache.qpid.protonj2.client.SessionOptions)" class="member-name-link">openSession</a><wbr>(<a href="../SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a> sessionOptions)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ClientSession.</span><code><a href="../impl/ClientSession.html#rollbackTransaction()" class="member-name-link">rollbackTransaction</a>()</code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="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></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ClientSession.</span><code><a href="../impl/ClientSession.html#closeAsync()" class="member-name-link">closeAsync</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></div> |
| <div class="col-second odd-row-color"><span class="type-name-label">ClientSession.</span><code><a href="../impl/ClientSession.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)" class="member-name-link">closeAsync</a><wbr>(<a href="../ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a> error)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>></code></div> |
| <div class="col-second even-row-color"><span class="type-name-label">ClientSession.</span><code><a href="../impl/ClientSession.html#openFuture()" class="member-name-link">openFuture</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |