| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ProtonSession (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="ProtonSession (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/ProtonSession.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.engine.impl</a></div> |
| <h2 title="Class ProtonSession" class="title">Class ProtonSession</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="ProtonEndpoint.html" title="class in org.apache.qpid.protonj2.engine.impl">org.apache.qpid.protonj2.engine.impl.ProtonEndpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.engine.impl.ProtonSession</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code>, <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ProtonSession</span> |
| extends <a href="ProtonEndpoint.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEndpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>> |
| implements <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></pre> |
| <div class="block">Proton API for Session type.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.qpid.protonj2.engine.impl.ProtonEndpoint"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.qpid.protonj2.engine.impl.<a href="ProtonEndpoint.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEndpoint</a></h3> |
| <code><a href="ProtonEndpoint.html#engine">engine</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.qpid.protonj2.engine.impl.ProtonConnection,int)">ProtonSession</a></span>​(<a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a> connection, |
| int localChannel)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonSession</code></a> instance bound to the given <a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonConnection</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></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">Close the end point locally and send the closing performative immediately if possible or |
| holds it until the Connection / Engine state allows it.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine">TransactionController</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#coordinator(java.lang.String)">coordinator</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> using the provided name.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deliveryReadHandler(org.apache.qpid.protonj2.engine.EventHandler)">deliveryReadHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../IncomingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">IncomingDelivery</a>> deliveryReadHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">Allows monitoring of incoming deliveries to receivers attached to this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnection()">getConnection</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDesiredCapabilities()">getDesiredCapabilities</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHandleMax()">getHandleMax</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIncomingCapacity()">getIncomingCapacity</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalChannel()">getLocalChannel</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOfferedCapabilities()">getOfferedCapabilities</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutgoingCapacity()">getOutgoingCapacity</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParent()">getParent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the parent of this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> which can be itself for <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProperties()">getProperties</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemainingIncomingCapacity()">getRemainingIncomingCapacity</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemainingOutgoingCapacity()">getRemainingOutgoingCapacity</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteChannel()">getRemoteChannel</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteDesiredCapabilities()">getRemoteDesiredCapabilities</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteOfferedCapabilities()">getRemoteOfferedCapabilities</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteProperties()">getRemoteProperties</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../SessionState.html" title="enum in org.apache.qpid.protonj2.engine">SessionState</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteState()">getRemoteState</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../SessionState.html" title="enum in org.apache.qpid.protonj2.engine">SessionState</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getState()">getState</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLocallyClosed()">isLocallyClosed</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently locally closed meaning that a call to the |
| <a href="../Endpoint.html#close()"><code>Endpoint.close()</code></a> method has occurred.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLocallyOpen()">isLocallyOpen</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently locally open meaning that the <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a> |
| has been called but the <a href="../Endpoint.html#close()"><code>Endpoint.close()</code></a> has not.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRemotelyClosed()">isRemotelyClosed</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently remotely closed meaning that the AMQP performative |
| that completes the close phase of this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s lifetime has arrived.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRemotelyOpen()">isRemotelyOpen</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently remotely open meaning that the AMQP performative |
| that completes the open phase of this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s lifetime has arrived but the performative |
| that closes it has not.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><?>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#links()">links</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a> of all <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> and <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> instances that are being tracked by |
| this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#open()">open</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Open the end point locally, sending the Open performative immediately if possible or holding |
| it until SASL negotiations or the AMQP header exchange and other required performative exchanges |
| has completed.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonReceiver.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonReceiver</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiver(java.lang.String)">receiver</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> link using the provided name</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiverOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">receiverOpenHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine">Receiver</a>> remoteReceiverOpenEventHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Attach frame is received from the remote peer for a receiving link.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="ProtonReceiver.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonReceiver</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receivers()">receivers</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a> of <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> instances that are being tracked by this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sender(java.lang.String)">sender</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> link using the provided name.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#senderOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">senderOpenHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a>> remoteSenderOpenEventHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Attach frame is received from the remote peer for a sending link.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#senders()">senders</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a> of <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> instances that are being tracked by this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDesiredCapabilities(org.apache.qpid.protonj2.types.Symbol...)">setDesiredCapabilities</a></span>​(<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... capabilities)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the capabilities that are desired from the remote when this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is |
| opened.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHandleMax(long)">setHandleMax</a></span>​(long handleMax)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the handle max value for this Session.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIncomingCapacity(int)">setIncomingCapacity</a></span>​(int incomingCapacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum number of bytes this session can be sent from the remote.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOfferedCapabilities(org.apache.qpid.protonj2.types.Symbol...)">setOfferedCapabilities</a></span>​(<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... capabilities)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the capabilities to be offered on to the remote when this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is |
| opened.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOutgoingCapacity(int)">setOutgoingCapacity</a></span>​(int outgoingCapacity)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the maximum number of bytes this session can be write before blocking additional |
| sends until the written bytes are known to have been flushed to the write.</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProperties(java.util.Map)">setProperties</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the properties to be sent to the remote when this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is Opened.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transactionManagerOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">transactionManagerOpenHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine">TransactionManager</a>> remoteTxnManagerOpenEventHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Attach frame is received from the remote peer for a transaction |
| coordination link.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.engine.impl.ProtonEndpoint"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.qpid.protonj2.engine.impl.<a href="ProtonEndpoint.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEndpoint</a></h3> |
| <code><a href="ProtonEndpoint.html#closeHandler(org.apache.qpid.protonj2.engine.EventHandler)">closeHandler</a>, <a href="ProtonEndpoint.html#engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)">engineShutdownHandler</a>, <a href="ProtonEndpoint.html#getAttachments()">getAttachments</a>, <a href="ProtonEndpoint.html#getCondition()">getCondition</a>, <a href="ProtonEndpoint.html#getEngine()">getEngine</a>, <a href="ProtonEndpoint.html#getLinkedResource()">getLinkedResource</a>, <a href="ProtonEndpoint.html#getLinkedResource(java.lang.Class)">getLinkedResource</a>, <a href="ProtonEndpoint.html#getRemoteCondition()">getRemoteCondition</a>, <a href="ProtonEndpoint.html#localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)">localCloseHandler</a>, <a href="ProtonEndpoint.html#localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">localOpenHandler</a>, <a href="ProtonEndpoint.html#openHandler(org.apache.qpid.protonj2.engine.EventHandler)">openHandler</a>, <a href="ProtonEndpoint.html#setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)">setCondition</a>, <a href="ProtonEndpoint.html#setLinkedResource(java.lang.Object)">setLinkedResource</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.engine.Endpoint"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.qpid.protonj2.engine.<a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a></h3> |
| <code><a href="../Endpoint.html#closeHandler(org.apache.qpid.protonj2.engine.EventHandler)">closeHandler</a>, <a href="../Endpoint.html#engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)">engineShutdownHandler</a>, <a href="../Endpoint.html#getAttachments()">getAttachments</a>, <a href="../Endpoint.html#getCondition()">getCondition</a>, <a href="../Endpoint.html#getEngine()">getEngine</a>, <a href="../Endpoint.html#getLinkedResource()">getLinkedResource</a>, <a href="../Endpoint.html#getLinkedResource(java.lang.Class)">getLinkedResource</a>, <a href="../Endpoint.html#getRemoteCondition()">getRemoteCondition</a>, <a href="../Endpoint.html#localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)">localCloseHandler</a>, <a href="../Endpoint.html#localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">localOpenHandler</a>, <a href="../Endpoint.html#openHandler(org.apache.qpid.protonj2.engine.EventHandler)">openHandler</a>, <a href="../Endpoint.html#setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)">setCondition</a>, <a href="../Endpoint.html#setLinkedResource(java.lang.Object)">setLinkedResource</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.qpid.protonj2.engine.impl.ProtonConnection,int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ProtonSession</h4> |
| <pre>public ProtonSession​(<a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a> connection, |
| int localChannel)</pre> |
| <div class="block">Creates a new <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonSession</code></a> instance bound to the given <a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonConnection</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connection</code> - The connection that is the parent of the session instance.</dd> |
| <dd><code>localChannel</code> - The local channel onto which this session is bound.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getConnection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnection</h4> |
| <pre class="methodSignature">public <a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a> getConnection()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#getConnection()">getConnection</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parent <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> for this Session.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParent</h4> |
| <pre class="methodSignature">public <a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a> getParent()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#getParent()">Endpoint</a></code></span></div> |
| <div class="block">Gets the parent of this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> which can be itself for <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getParent()">getParent</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#getParent()">getParent</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parent <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> of the <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocalChannel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalChannel</h4> |
| <pre class="methodSignature">public int getLocalChannel()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local channel onto which this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a> is bound.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteChannel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteChannel</h4> |
| <pre class="methodSignature">public int getRemoteChannel()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote channel onto which this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a> is bound or -1 if not yet remotely opened.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre class="methodSignature">public <a href="../SessionState.html" title="enum in org.apache.qpid.protonj2.engine">SessionState</a> getState()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#getState()">getState</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local session state</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteState</h4> |
| <pre class="methodSignature">public <a href="../SessionState.html" title="enum in org.apache.qpid.protonj2.engine">SessionState</a> getRemoteState()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#getRemoteState()">getRemoteState</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote session state (as last communicated)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="open()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>open</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> open() |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a>, |
| <a href="../exceptions/EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#open()">Endpoint</a></code></span></div> |
| <div class="block">Open the end point locally, sending the Open performative immediately if possible or holding |
| it until SASL negotiations or the AMQP header exchange and other required performative exchanges |
| has completed. |
| |
| The end point will signal any registered handler of the remote opening the Connection |
| once the remote performative that signals open completion arrives.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#open()">open</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/EngineStateException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineStateException</a></code> - if an error occurs opening the Connection or the Engine is shutdown.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> close() |
| throws <a href="../exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#close()">Endpoint</a></code></span></div> |
| <div class="block">Close the end point locally and send the closing performative immediately if possible or |
| holds it until the Connection / Engine state allows it. If the engine encounters an error writing |
| the performative or the engine is in a failed state from a previous error then this method will |
| throw an exception. If the engine has been shutdown then this method will close out the local |
| end of the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> and clean up any local resources before returning normally.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#close()">close</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../exceptions/EngineFailedException.html" title="class in org.apache.qpid.protonj2.engine.exceptions">EngineFailedException</a></code> - if an error occurs closing the end point or the Engine is in a failed state.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isLocallyOpen()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocallyOpen</h4> |
| <pre class="methodSignature">public boolean isLocallyOpen()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#isLocallyOpen()">Endpoint</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently locally open meaning that the <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a> |
| has been called but the <a href="../Endpoint.html#close()"><code>Endpoint.close()</code></a> has not.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#isLocallyOpen()">isLocallyOpen</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is locally open.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Endpoint.html#isLocallyClosed()"><code>Endpoint.isLocallyClosed()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isLocallyClosed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocallyClosed</h4> |
| <pre class="methodSignature">public boolean isLocallyClosed()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#isLocallyClosed()">Endpoint</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently locally closed meaning that a call to the |
| <a href="../Endpoint.html#close()"><code>Endpoint.close()</code></a> method has occurred.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#isLocallyClosed()">isLocallyClosed</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is locally closed.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Endpoint.html#isLocallyOpen()"><code>Endpoint.isLocallyOpen()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setIncomingCapacity(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIncomingCapacity</h4> |
| <pre class="methodSignature">public <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a> setIncomingCapacity​(int incomingCapacity)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#setIncomingCapacity(int)">Session</a></code></span></div> |
| <div class="block">Sets the maximum number of bytes this session can be sent from the remote.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#setIncomingCapacity(int)">setIncomingCapacity</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>incomingCapacity</code> - maximum number of incoming bytes this session will allow</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIncomingCapacity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIncomingCapacity</h4> |
| <pre class="methodSignature">public int getIncomingCapacity()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#getIncomingCapacity()">getIncomingCapacity</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current incoming capacity of this session.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemainingIncomingCapacity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemainingIncomingCapacity</h4> |
| <pre class="methodSignature">public int getRemainingIncomingCapacity()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#getRemainingIncomingCapacity()">getRemainingIncomingCapacity</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remaining session capacity based on how many bytes are currently pending,</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setOutgoingCapacity(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOutgoingCapacity</h4> |
| <pre class="methodSignature">public <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a> setOutgoingCapacity​(int outgoingCapacity)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#setOutgoingCapacity(int)">Session</a></code></span></div> |
| <div class="block">Sets the maximum number of bytes this session can be write before blocking additional |
| sends until the written bytes are known to have been flushed to the write. This limit |
| is intended to deal with issues of memory allocation when the I/O layer allows for |
| asynchronous writes and finer grained control over the pending write buffers is needed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#setOutgoingCapacity(int)">setOutgoingCapacity</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>outgoingCapacity</code> - maximum number of outgoing bytes this session will allow before stopping senders from sending.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOutgoingCapacity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutgoingCapacity</h4> |
| <pre class="methodSignature">public int getOutgoingCapacity()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#getOutgoingCapacity()">getOutgoingCapacity</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current outgoing capacity limit of this session.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemainingOutgoingCapacity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemainingOutgoingCapacity</h4> |
| <pre class="methodSignature">public int getRemainingOutgoingCapacity()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#getRemainingOutgoingCapacity()">getRemainingOutgoingCapacity</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remaining session outgoing capacity based on how many bytes are currently pending,</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHandleMax(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHandleMax</h4> |
| <pre class="methodSignature">public <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a> setHandleMax​(long handleMax) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#setHandleMax(long)">Session</a></code></span></div> |
| <div class="block">Set the handle max value for this Session. |
| |
| The handle max value can only be modified prior to a call to <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a>, |
| once the session has been opened locally an error will be thrown if this method |
| is called.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#setHandleMax(long)">setHandleMax</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>handleMax</code> - The value to set for handle max when opening the session.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the Session has already been opened.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHandleMax()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHandleMax</h4> |
| <pre class="methodSignature">public long getHandleMax()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#getHandleMax()">getHandleMax</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the currently configured handle max for this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setProperties(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperties</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> setProperties​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> properties)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#setProperties(java.util.Map)">Endpoint</a></code></span></div> |
| <div class="block">Sets the properties to be sent to the remote when this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is Opened. |
| |
| The <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> properties value can only be modified prior to a call to <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a>, |
| once the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has been opened locally an error will be thrown if this method |
| is called.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#setProperties(java.util.Map)">setProperties</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>properties</code> - The properties that will be sent to the remote when this Connection is opened.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> getProperties()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getProperties()">getProperties</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured properties sent to the remote when this Connection is opened.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setOfferedCapabilities(org.apache.qpid.protonj2.types.Symbol...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOfferedCapabilities</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> setOfferedCapabilities​(<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... capabilities)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#setOfferedCapabilities(org.apache.qpid.protonj2.types.Symbol...)">Endpoint</a></code></span></div> |
| <div class="block">Sets the capabilities to be offered on to the remote when this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is |
| opened. |
| |
| The offered capabilities value can only be modified prior to a call to <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a>, |
| once the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has been opened locally an error will be thrown if this method |
| is called.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#setOfferedCapabilities(org.apache.qpid.protonj2.types.Symbol...)">setOfferedCapabilities</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>capabilities</code> - The capabilities to be offered to the remote when the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOfferedCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOfferedCapabilities</h4> |
| <pre class="methodSignature">public <a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[] getOfferedCapabilities()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getOfferedCapabilities()">getOfferedCapabilities</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured capabilities that are offered to the remote when the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDesiredCapabilities(org.apache.qpid.protonj2.types.Symbol...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDesiredCapabilities</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> setDesiredCapabilities​(<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>... capabilities)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#setDesiredCapabilities(org.apache.qpid.protonj2.types.Symbol...)">Endpoint</a></code></span></div> |
| <div class="block">Sets the capabilities that are desired from the remote when this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is |
| opened. |
| |
| The desired capabilities value can only be modified prior to a call to <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a>, |
| once the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has been opened locally an error will be thrown if this method |
| is called.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#setDesiredCapabilities(org.apache.qpid.protonj2.types.Symbol...)">setDesiredCapabilities</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>capabilities</code> - The capabilities desired from the remote when the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getDesiredCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDesiredCapabilities</h4> |
| <pre class="methodSignature">public <a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[] getDesiredCapabilities()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getDesiredCapabilities()">getDesiredCapabilities</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured desired capabilities that are sent to the remote when the Connection is opened.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="links()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>links</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><?>> links()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#links()">Session</a></code></span></div> |
| <div class="block">Returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a> of all <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> and <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> instances that are being tracked by |
| this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#links()">links</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a set of Sender and Receiver instances tracked by this session.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="senders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>senders</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a>> senders()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#senders()">Session</a></code></span></div> |
| <div class="block">Returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a> of <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> instances that are being tracked by this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#senders()">senders</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a set of Sender instances tracked by this session.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="receivers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>receivers</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="ProtonReceiver.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonReceiver</a>> receivers()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#receivers()">Session</a></code></span></div> |
| <div class="block">Returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a> of <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> instances that are being tracked by this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#receivers()">receivers</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a set of Receiver instances tracked by this session.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRemotelyOpen()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRemotelyOpen</h4> |
| <pre class="methodSignature">public boolean isRemotelyOpen()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#isRemotelyOpen()">Endpoint</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently remotely open meaning that the AMQP performative |
| that completes the open phase of this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s lifetime has arrived but the performative |
| that closes it has not.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#isRemotelyOpen()">isRemotelyOpen</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is remotely open.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Endpoint.html#isRemotelyClosed()"><code>Endpoint.isRemotelyClosed()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRemotelyClosed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRemotelyClosed</h4> |
| <pre class="methodSignature">public boolean isRemotelyClosed()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#isRemotelyClosed()">Endpoint</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is currently remotely closed meaning that the AMQP performative |
| that completes the close phase of this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s lifetime has arrived.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#isRemotelyClosed()">isRemotelyClosed</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is remotely closed.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Endpoint.html#isRemotelyOpen()"><code>Endpoint.isRemotelyOpen()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteOfferedCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteOfferedCapabilities</h4> |
| <pre class="methodSignature">public <a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[] getRemoteOfferedCapabilities()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getRemoteOfferedCapabilities()">getRemoteOfferedCapabilities</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the capabilities offered by the remote when it opened its end of the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteDesiredCapabilities()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteDesiredCapabilities</h4> |
| <pre class="methodSignature">public <a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>[] getRemoteDesiredCapabilities()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getRemoteDesiredCapabilities()">getRemoteDesiredCapabilities</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the capabilities desired by the remote when it opened its end of the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteProperties()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteProperties</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="../../types/Symbol.html" title="class in org.apache.qpid.protonj2.types">Symbol</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>> getRemoteProperties()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getRemoteProperties()">getRemoteProperties</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the properties sent by the remote when it opened its end of the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sender(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sender</h4> |
| <pre class="methodSignature">public <a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a> sender​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#sender(java.lang.String)">Session</a></code></span></div> |
| <div class="block">Create a new <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> link using the provided name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#sender(java.lang.String)">sender</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name to assign to the created <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly created <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="receiver(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>receiver</h4> |
| <pre class="methodSignature">public <a href="ProtonReceiver.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonReceiver</a> receiver​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#receiver(java.lang.String)">Session</a></code></span></div> |
| <div class="block">Create a new <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> link using the provided name</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#receiver(java.lang.String)">receiver</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name to assign to the created <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly created <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="coordinator(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>coordinator</h4> |
| <pre class="methodSignature">public <a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine">TransactionController</a> coordinator​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#coordinator(java.lang.String)">Session</a></code></span></div> |
| <div class="block">Create a new <a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> using the provided name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#coordinator(java.lang.String)">coordinator</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name to assign to the created <a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly created <a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a> has already been closed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="senderOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>senderOpenHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> senderOpenHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a>> remoteSenderOpenEventHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#senderOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">Session</a></code></span></div> |
| <div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Attach frame is received from the remote peer for a sending link. |
| |
| Used to process remotely initiated sending link. Locally initiated links have their own EventHandler |
| invoked instead. This method is Typically used by servers to listen for remote Receiver creation. |
| If an event handler for remote sender open is registered on this Session for a link scoped to it then |
| this handler will be invoked instead of the variant in the Connection API.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#senderOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">senderOpenHandler</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteSenderOpenEventHandler</code> - the EventHandler that will be signaled when a sender link is remotely opened.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this session for chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="receiverOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>receiverOpenHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> receiverOpenHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine">Receiver</a>> remoteReceiverOpenEventHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#receiverOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">Session</a></code></span></div> |
| <div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Attach frame is received from the remote peer for a receiving link. |
| |
| Used to process remotely initiated receiving link. Locally initiated links have their own EventHandler |
| invoked instead. This method is Typically used by servers to listen for remote Sender creation. |
| If an event handler for remote sender open is registered on this Session for a link scoped to it then |
| this handler will be invoked instead of the variant in the Connection API.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#receiverOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">receiverOpenHandler</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteReceiverOpenEventHandler</code> - the EventHandler that will be signaled when a receiver link is remotely opened.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this session for chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="transactionManagerOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transactionManagerOpenHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> transactionManagerOpenHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine">TransactionManager</a>> remoteTxnManagerOpenEventHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#transactionManagerOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">Session</a></code></span></div> |
| <div class="block">Sets a <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> for when an AMQP Attach frame is received from the remote peer for a transaction |
| coordination link. |
| |
| Used to process remotely initiated transaction manager link. Locally initiated links have their own EventHandler |
| invoked instead. This method is Typically used by servers to listen for remote <a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> |
| creation. If an event handler for remote <a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> open is registered on this Session for a |
| <a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> scoped to it then this handler will be invoked instead of the variant in the |
| <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> API.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#transactionManagerOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">transactionManagerOpenHandler</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteTxnManagerOpenEventHandler</code> - the EventHandler that will be signaled when a <a href="../TransactionController.html" title="interface in org.apache.qpid.protonj2.engine"><code>TransactionController</code></a> link is remotely opened.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a> for chaining</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="deliveryReadHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>deliveryReadHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> deliveryReadHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../IncomingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">IncomingDelivery</a>> deliveryReadHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Session.html#deliveryReadHandler(org.apache.qpid.protonj2.engine.EventHandler)">Session</a></code></span></div> |
| <div class="block">Allows monitoring of incoming deliveries to receivers attached to this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a>. The |
| <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> that is the target of the incoming delivery will be notified first of the |
| incoming delivery and any processing should be done using the <a href="../Receiver.html#deliveryReadHandler(org.apache.qpid.protonj2.engine.EventHandler)"><code>Receiver.deliveryReadHandler(EventHandler)</code></a>. |
| This event point will be trigger only after the <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> level handler and should be |
| used to monitor deliveries passing through a session for logging or other state related actions |
| performed by the service managing this session.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Session.html#deliveryReadHandler(org.apache.qpid.protonj2.engine.EventHandler)">deliveryReadHandler</a></code> in interface <code><a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>deliveryReadHandler</code> - The delivery that was read which contains</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a> for chaining</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/ProtonSession.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><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
