| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ProtonLink (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="ProtonLink (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6,"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":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":6,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ProtonLink.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><a href="#field.detail">Field</a> | </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 ProtonLink" class="title">Class ProtonLink<L extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><L>></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><L></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.engine.impl.ProtonLink<L></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>L</code> - the type of link, <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> or <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a>.</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><L></code>, <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><L></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="ProtonReceiver.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonReceiver</a></code>, <code><a href="ProtonSender.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSender</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">ProtonLink<L extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><L>></span> |
| extends <a href="ProtonEndpoint.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEndpoint</a><L> |
| implements <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><L></pre> |
| <div class="block">Common base for Proton Senders and Receivers.</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> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <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="#connection">connection</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../types/transport/Attach.html" title="class in org.apache.qpid.protonj2.types.transport">Attach</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localAttach">localAttach</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../types/transport/Attach.html" title="class in org.apache.qpid.protonj2.types.transport">Attach</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remoteAttach">remoteAttach</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <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="#session">session</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <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">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.qpid.protonj2.engine.impl.ProtonSession,java.lang.String,org.apache.qpid.protonj2.engine.impl.ProtonLinkCreditState)">ProtonLink</a></span>​(<a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> session, |
| <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, |
| <a href="ProtonLinkCreditState.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonLinkCreditState</a> creditState)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new link instance with the given parent session.</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#areDeliveriesStillActive()">areDeliveriesStillActive</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkLinkOperable(java.lang.String)">checkLinkOperable</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> failurePrefix)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkNotClosed(java.lang.String)">checkNotClosed</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> errorMessage)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkNotOpened(java.lang.String)">checkNotOpened</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> errorMessage)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="i5" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decorateOutgoingFlow(org.apache.qpid.protonj2.types.transport.Flow)">decorateOutgoingFlow</a></span>​(<a href="../../types/transport/Flow.html" title="class in org.apache.qpid.protonj2.types.transport">Flow</a> flow)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detach()">detach</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Detach this end of the link.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detachHandler(org.apache.qpid.protonj2.engine.EventHandler)">detachHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>> remoteDetachHandler)</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 Detach frame is received from the remote peer for this |
| <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> which would have been locally opened previously, the Detach from would have been marked |
| as not having been closed.</div> |
| </td> |
| </tr> |
| <tr id="i8" 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="#getConnection()">getConnection</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" 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="#getDesiredCapabilities()">getDesiredCapabilities</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxMessageSize()">getMaxMessageSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the local link max message size.</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/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" 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="i13" 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="#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="i14" class="altColor"> |
| <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="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">ReceiverSettleMode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReceiverSettleMode()">getReceiverSettleMode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the local link receiver settlement mode.</div> |
| </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="#getRemoteDesiredCapabilities()">getRemoteDesiredCapabilities</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteMaxMessageSize()">getRemoteMaxMessageSize</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the remote link max message size, as conveyed from the peer via the Attach frame |
| when attaching the link to the session.</div> |
| </td> |
| </tr> |
| <tr id="i18" 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="i19" 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="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">ReceiverSettleMode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteReceiverSettleMode()">getRemoteReceiverSettleMode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the remote link receiver settlement mode, as conveyed from the peer via the Attach frame |
| when attaching the link to the session.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/transport/SenderSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">SenderSettleMode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteSenderSettleMode()">getRemoteSenderSettleMode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the remote link sender settlement mode, as conveyed from the peer via the Attach frame |
| when attaching the link to the session.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging">Source</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteSource()">getRemoteSource</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../LinkState.html" title="enum in org.apache.qpid.protonj2.engine">LinkState</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="i24" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging">Terminus</a>><br>T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteTarget()">getRemoteTarget</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the remote target <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Terminus</code></a> cast to the given type.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/transport/SenderSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">SenderSettleMode</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSenderSettleMode()">getSenderSettleMode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the local link sender settlement mode.</div> |
| </td> |
| </tr> |
| <tr id="i26" 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="#getSession()">getSession</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging">Source</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSource()">getSource</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../LinkState.html" title="enum in org.apache.qpid.protonj2.engine">LinkState</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="i29" class="rowColor"> |
| <td class="colFirst"><code><T extends <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging">Terminus</a>><br>T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTarget()">getTarget</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the currently set Target for this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleRemoteAttach(org.apache.qpid.protonj2.types.transport.Attach)">handleRemoteAttach</a></span>​(<a href="../../types/transport/Attach.html" title="class in org.apache.qpid.protonj2.types.transport">Attach</a> attach)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleRemoteDetach(org.apache.qpid.protonj2.types.transport.Detach)">handleRemoteDetach</a></span>​(<a href="../../types/transport/Detach.html" title="class in org.apache.qpid.protonj2.types.transport">Detach</a> detach)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleRemoteDisposition(org.apache.qpid.protonj2.types.transport.Disposition,org.apache.qpid.protonj2.engine.impl.ProtonIncomingDelivery)">handleRemoteDisposition</a></span>​(<a href="../../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport">Disposition</a> disposition, |
| <a href="ProtonIncomingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonIncomingDelivery</a> delivery)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleRemoteDisposition(org.apache.qpid.protonj2.types.transport.Disposition,org.apache.qpid.protonj2.engine.impl.ProtonOutgoingDelivery)">handleRemoteDisposition</a></span>​(<a href="../../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport">Disposition</a> disposition, |
| <a href="ProtonOutgoingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonOutgoingDelivery</a> delivery)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleRemoteFlow(org.apache.qpid.protonj2.types.transport.Flow)">handleRemoteFlow</a></span>​(<a href="../../types/transport/Flow.html" title="class in org.apache.qpid.protonj2.types.transport">Flow</a> flow)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="ProtonIncomingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonIncomingDelivery</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleRemoteTransfer(org.apache.qpid.protonj2.types.transport.Transfer,org.apache.qpid.protonj2.buffer.ProtonBuffer)">handleRemoteTransfer</a></span>​(<a href="../../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport">Transfer</a> transfer, |
| <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> payload)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i36" 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="i37" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLocallyClosedOrDetached()">isLocallyClosedOrDetached</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently locally detached or locally closed meaning the |
| state returned from <a href="../Link.html#getState()"><code>Link.getState()</code></a> is equal to <a href="../LinkState.html#DETACHED"><code>LinkState.DETACHED</code></a> or |
| <a href="../LinkState.html#CLOSED"><code>LinkState.CLOSED</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLocallyDetached()">isLocallyDetached</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently locally detached meaning the state returned |
| from <a href="../Link.html#getState()"><code>Link.getState()</code></a> is equal to <a href="../LinkState.html#DETACHED"><code>LinkState.DETACHED</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i39" 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="i40" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReceiver()">isReceiver</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <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="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently remotely closed meaning the state returned |
| from <a href="../Link.html#getRemoteState()"><code>Link.getRemoteState()</code></a> is equal to <a href="../LinkState.html#CLOSED"><code>LinkState.CLOSED</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRemotelyClosedOrDetached()">isRemotelyClosedOrDetached</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently remotely detached or closed meaning the state |
| returned from <a href="../Link.html#getRemoteState()"><code>Link.getRemoteState()</code></a> is equal to <a href="../LinkState.html#DETACHED"><code>LinkState.DETACHED</code></a> or |
| <a href="../LinkState.html#CLOSED"><code>LinkState.CLOSED</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRemotelyDetached()">isRemotelyDetached</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently remotely detached meaning the state returned |
| from <a href="../Link.html#getRemoteState()"><code>Link.getRemoteState()</code></a> is equal to <a href="../LinkState.html#DETACHED"><code>LinkState.DETACHED</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <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="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently remotely open meaning the state returned |
| from <a href="../Link.html#getRemoteState()"><code>Link.getRemoteState()</code></a> is equal to <a href="../LinkState.html#ACTIVE"><code>LinkState.ACTIVE</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSender()">isSender</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localDetachHandler(org.apache.qpid.protonj2.engine.EventHandler)">localDetachHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>> localDetachHandler)</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 this link is detached locally via a call to <a href="../Link.html#detach()"><code>Link.detach()</code></a> |
| |
| This is a convenience event that supplements the normal <a href="../Endpoint.html#localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)"><code>Endpoint.localCloseHandler(EventHandler)</code></a> |
| event point if set.</div> |
| </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="i48" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parentEndpointClosedHandler(org.apache.qpid.protonj2.engine.EventHandler)">parentEndpointClosedHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>> handler)</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 the parent <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a> or <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> of this link is |
| locally closed.</div> |
| </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code>protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#self()">self</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="i51" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxMessageSize(org.apache.qpid.protonj2.types.UnsignedLong)">setMaxMessageSize</a></span>​(<a href="../../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a> maxMessageSize)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the local link max message size, to be conveyed to the peer via the Attach frame |
| when attaching the link to the session.</div> |
| </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="i54" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReceiverSettleMode(org.apache.qpid.protonj2.types.transport.ReceiverSettleMode)">setReceiverSettleMode</a></span>​(<a href="../../types/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">ReceiverSettleMode</a> receiverSettleMode)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the receiver settle mode.</div> |
| </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSenderSettleMode(org.apache.qpid.protonj2.types.transport.SenderSettleMode)">setSenderSettleMode</a></span>​(<a href="../../types/transport/SenderSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">SenderSettleMode</a> senderSettleMode)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the sender settle mode.</div> |
| </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSource(org.apache.qpid.protonj2.types.messaging.Source)">setSource</a></span>​(<a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging">Source</a> source)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Source</code></a> to assign to the local end of this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTarget(org.apache.qpid.protonj2.types.messaging.Target)">setTarget</a></span>​(<a href="../../types/messaging/Target.html" title="class in org.apache.qpid.protonj2.types.messaging">Target</a> target)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <a href="../../types/messaging/Target.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Target</code></a> to assign to the local end of this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonLink.html" title="type parameter in ProtonLink">L</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTarget(org.apache.qpid.protonj2.types.transactions.Coordinator)">setTarget</a></span>​(<a href="../../types/transactions/Coordinator.html" title="class in org.apache.qpid.protonj2.types.transactions">Coordinator</a> coordinator)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the <a href="../../types/transactions/Coordinator.html" title="class in org.apache.qpid.protonj2.types.transactions"><code>Coordinator</code></a> target to assign to the local end of this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transitionedToLocallyClosed()">transitionedToLocallyClosed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transitionedToLocallyDetached()">transitionedToLocallyDetached</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transitionedToLocallyOpened()">transitionedToLocallyOpened</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transitionToParentLocallyClosed()">transitionToParentLocallyClosed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transitionToParentRemotelyClosed()">transitionToParentRemotelyClosed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transitionToRemotelyClosed()">transitionToRemotelyClosed</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transitionToRemotelyDetached()">transitionToRemotelyDetached</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transitionToRemotelyOpenedState()">transitionToRemotelyOpenedState</a></span>()</code></th> |
| <td class="colLast"> </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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.qpid.protonj2.engine.Link"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.qpid.protonj2.engine.<a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a></h3> |
| <code><a href="../Link.html#creditStateUpdateHandler(org.apache.qpid.protonj2.engine.EventHandler)">creditStateUpdateHandler</a>, <a href="../Link.html#getCredit()">getCredit</a>, <a href="../Link.html#getRole()">getRole</a>, <a href="../Link.html#isDraining()">isDraining</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="connection"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>connection</h4> |
| <pre>protected final <a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a> connection</pre> |
| </li> |
| </ul> |
| <a id="session"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>session</h4> |
| <pre>protected final <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> session</pre> |
| </li> |
| </ul> |
| <a id="localAttach"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localAttach</h4> |
| <pre>protected final <a href="../../types/transport/Attach.html" title="class in org.apache.qpid.protonj2.types.transport">Attach</a> localAttach</pre> |
| </li> |
| </ul> |
| <a id="remoteAttach"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>remoteAttach</h4> |
| <pre>protected <a href="../../types/transport/Attach.html" title="class in org.apache.qpid.protonj2.types.transport">Attach</a> remoteAttach</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= 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.ProtonSession,java.lang.String,org.apache.qpid.protonj2.engine.impl.ProtonLinkCreditState)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ProtonLink</h4> |
| <pre>protected ProtonLink​(<a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> session, |
| <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, |
| <a href="ProtonLinkCreditState.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonLinkCreditState</a> creditState)</pre> |
| <div class="block">Create a new link instance with the given parent session.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a> that this link resides within.</dd> |
| <dd><code>name</code> - The name assigned to this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a></dd> |
| <dd><code>creditState</code> - The link credit state used to track credit for the link.</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="../Link.html#getConnection()">getConnection</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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 the <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a> getSession()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getSession()">getSession</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parent <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</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="getParent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParent</h4> |
| <pre class="methodSignature">public <a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getParent()">getParent</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the parent <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</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="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre class="methodSignature">public <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> getName()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getName()">getName</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the link name that is assigned to this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSender()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSender</h4> |
| <pre class="methodSignature">public boolean isSender()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#isSender()">isSender</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this link is acting in a sender <a href="../../types/transport/Role.html" title="enum in org.apache.qpid.protonj2.types.transport"><code>Role</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isReceiver()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isReceiver</h4> |
| <pre class="methodSignature">public boolean isReceiver()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#isReceiver()">isReceiver</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this link is acting in a receiver <a href="../../types/transport/Role.html" title="enum in org.apache.qpid.protonj2.types.transport"><code>Role</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="self()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>self</h4> |
| <pre class="methodSignature">protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> self()</pre> |
| </li> |
| </ul> |
| <a id="getState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre class="methodSignature">public <a href="../LinkState.html" title="enum in org.apache.qpid.protonj2.engine">LinkState</a> getState()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getState()">getState</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local link state</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteState</h4> |
| <pre class="methodSignature">public <a href="../LinkState.html" title="enum in org.apache.qpid.protonj2.engine">LinkState</a> getRemoteState()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getRemoteState()">getRemoteState</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote link 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="ProtonLink.html" title="type parameter in ProtonLink">L</a> open()</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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> |
| </dl> |
| </li> |
| </ul> |
| <a id="detach()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detach</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> detach()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#detach()">Link</a></code></span></div> |
| <div class="block">Detach this end of the link.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#detach()">detach</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Link.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="close()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> close()</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSenderSettleMode(org.apache.qpid.protonj2.types.transport.SenderSettleMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSenderSettleMode</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> setSenderSettleMode​(<a href="../../types/transport/SenderSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">SenderSettleMode</a> senderSettleMode)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#setSenderSettleMode(org.apache.qpid.protonj2.types.transport.SenderSettleMode)">Link</a></code></span></div> |
| <div class="block">Sets the sender settle mode. |
| <p> |
| Should only be called during link set-up, i.e. before calling <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a>. If this endpoint is the |
| initiator of the link, this method can be used to set a value other than the default. |
| <p> |
| If this endpoint is not the initiator, this method should be used to set a local value. According |
| to the AMQP spec, the application may choose to accept the sender's suggestion |
| (accessed by calling <a href="../Link.html#getRemoteSenderSettleMode()"><code>Link.getRemoteSenderSettleMode()</code></a>) or choose another value. The value |
| has no effect on Proton, but may be useful to the application at a later point. |
| <p> |
| In order to be AMQP compliant the application is responsible for honoring the settlement mode. See <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#setSenderSettleMode(org.apache.qpid.protonj2.types.transport.SenderSettleMode)">setSenderSettleMode</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>senderSettleMode</code> - The <a href="../../types/transport/SenderSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport"><code>SenderSettleMode</code></a> that will be set on the local end of this link.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Link.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSenderSettleMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSenderSettleMode</h4> |
| <pre class="methodSignature">public <a href="../../types/transport/SenderSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">SenderSettleMode</a> getSenderSettleMode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#getSenderSettleMode()">Link</a></code></span></div> |
| <div class="block">Gets the local link sender settlement mode.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getSenderSettleMode()">getSenderSettleMode</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local sender settlement mode, or null if none was set.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Link.html#setSenderSettleMode(org.apache.qpid.protonj2.types.transport.SenderSettleMode)"><code>Link.setSenderSettleMode(SenderSettleMode)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setReceiverSettleMode(org.apache.qpid.protonj2.types.transport.ReceiverSettleMode)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setReceiverSettleMode</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> setReceiverSettleMode​(<a href="../../types/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">ReceiverSettleMode</a> receiverSettleMode)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#setReceiverSettleMode(org.apache.qpid.protonj2.types.transport.ReceiverSettleMode)">Link</a></code></span></div> |
| <div class="block">Sets the receiver settle mode. |
| <p> |
| Should only be called during link set-up, i.e. before calling <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a>. If this endpoint |
| is the initiator of the link, this method can be used to set a value other than the default. |
| |
| Used in analogous way to <a href="../Link.html#setSenderSettleMode(org.apache.qpid.protonj2.types.transport.SenderSettleMode)"><code>Link.setSenderSettleMode(SenderSettleMode)</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#setReceiverSettleMode(org.apache.qpid.protonj2.types.transport.ReceiverSettleMode)">setReceiverSettleMode</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>receiverSettleMode</code> - The <a href="../../types/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport"><code>ReceiverSettleMode</code></a> that will be set on the local end of this link.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Link.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getReceiverSettleMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getReceiverSettleMode</h4> |
| <pre class="methodSignature">public <a href="../../types/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">ReceiverSettleMode</a> getReceiverSettleMode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#getReceiverSettleMode()">Link</a></code></span></div> |
| <div class="block">Gets the local link receiver settlement mode.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getReceiverSettleMode()">getReceiverSettleMode</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local receiver settlement mode, or null if none was set.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Link.html#setReceiverSettleMode(org.apache.qpid.protonj2.types.transport.ReceiverSettleMode)"><code>Link.setReceiverSettleMode(ReceiverSettleMode)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSource(org.apache.qpid.protonj2.types.messaging.Source)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSource</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> setSource​(<a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging">Source</a> source)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#setSource(org.apache.qpid.protonj2.types.messaging.Source)">Link</a></code></span></div> |
| <div class="block">Sets the <a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Source</code></a> to assign to the local end of this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>. |
| <p> |
| Must be called during link setup, i.e. before calling the <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#setSource(org.apache.qpid.protonj2.types.messaging.Source)">setSource</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>source</code> - The <a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Source</code></a> that will be set on the local end of this link.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Link.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSource()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSource</h4> |
| <pre class="methodSignature">public <a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging">Source</a> getSource()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getSource()">getSource</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Source</code></a> for the local end of this link.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTarget(org.apache.qpid.protonj2.types.messaging.Target)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTarget</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> setTarget​(<a href="../../types/messaging/Target.html" title="class in org.apache.qpid.protonj2.types.messaging">Target</a> target)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#setTarget(org.apache.qpid.protonj2.types.messaging.Target)">Link</a></code></span></div> |
| <div class="block">Sets the <a href="../../types/messaging/Target.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Target</code></a> to assign to the local end of this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>. |
| |
| Must be called during link setup, i.e. before calling the <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#setTarget(org.apache.qpid.protonj2.types.messaging.Target)">setTarget</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - The <a href="../../types/messaging/Target.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Target</code></a> that will be set on the local end of this link.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Link.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTarget(org.apache.qpid.protonj2.types.transactions.Coordinator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTarget</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> setTarget​(<a href="../../types/transactions/Coordinator.html" title="class in org.apache.qpid.protonj2.types.transactions">Coordinator</a> coordinator) |
| 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="../Link.html#setTarget(org.apache.qpid.protonj2.types.transactions.Coordinator)">Link</a></code></span></div> |
| <div class="block">Sets the <a href="../../types/transactions/Coordinator.html" title="class in org.apache.qpid.protonj2.types.transactions"><code>Coordinator</code></a> target to assign to the local end of this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>. |
| <p> |
| Must be called during link setup, i.e. before calling the <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#setTarget(org.apache.qpid.protonj2.types.transactions.Coordinator)">setTarget</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>coordinator</code> - The <a href="../../types/transactions/Coordinator.html" title="class in org.apache.qpid.protonj2.types.transactions"><code>Coordinator</code></a> target that will be set on the local end of this link.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Link.</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="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> has already been opened.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTarget()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTarget</h4> |
| <pre class="methodSignature">public <T extends <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging">Terminus</a>> T getTarget()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#getTarget()">Link</a></code></span></div> |
| <div class="block">Returns the currently set Target for this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>. A link target can be either |
| a <a href="../../types/messaging/Target.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Target</code></a> type for a <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> or <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> link or if the link is |
| to be transaction resource then the target type will be a <a href="../../types/transactions/Coordinator.html" title="class in org.apache.qpid.protonj2.types.transactions"><code>Coordinator</code></a> instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getTarget()">getTarget</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The terminus type that the target should be cast to on return.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the link target <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Terminus</code></a> for the local end of this link.</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="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="setMaxMessageSize(org.apache.qpid.protonj2.types.UnsignedLong)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxMessageSize</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> setMaxMessageSize​(<a href="../../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a> maxMessageSize)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#setMaxMessageSize(org.apache.qpid.protonj2.types.UnsignedLong)">Link</a></code></span></div> |
| <div class="block">Sets the local link max message size, to be conveyed to the peer via the Attach frame |
| when attaching the link to the session. Null or 0 means no limit. |
| <p> |
| Must be called during link setup, i.e. before calling the <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a> method.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#setMaxMessageSize(org.apache.qpid.protonj2.types.UnsignedLong)">setMaxMessageSize</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxMessageSize</code> - the local max message size value, or null to clear. 0 also means no limit.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this Link.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxMessageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxMessageSize</h4> |
| <pre class="methodSignature">public <a href="../../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a> getMaxMessageSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#getMaxMessageSize()">Link</a></code></span></div> |
| <div class="block">Gets the local link max message size.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getMaxMessageSize()">getMaxMessageSize</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local max message size, or null if none was set. 0 also means no limit.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Link.html#setMaxMessageSize(org.apache.qpid.protonj2.types.UnsignedLong)"><code>Link.setMaxMessageSize(UnsignedLong)</code></a></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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="isLocallyDetached()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocallyDetached</h4> |
| <pre class="methodSignature">public boolean isLocallyDetached()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#isLocallyDetached()">Link</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently locally detached meaning the state returned |
| from <a href="../Link.html#getState()"><code>Link.getState()</code></a> is equal to <a href="../LinkState.html#DETACHED"><code>LinkState.DETACHED</code></a>. A link |
| is locally detached after a call to <a href="../Link.html#detach()"><code>Link.detach()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#isLocallyDetached()">isLocallyDetached</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the link is locally closed.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Endpoint.html#isLocallyOpen()"><code>Endpoint.isLocallyOpen()</code></a>, |
| <a href="../Endpoint.html#isLocallyClosed()"><code>Endpoint.isLocallyClosed()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isLocallyClosedOrDetached()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isLocallyClosedOrDetached</h4> |
| <pre class="methodSignature">public boolean isLocallyClosedOrDetached()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#isLocallyClosedOrDetached()">Link</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently locally detached or locally closed meaning the |
| state returned from <a href="../Link.html#getState()"><code>Link.getState()</code></a> is equal to <a href="../LinkState.html#DETACHED"><code>LinkState.DETACHED</code></a> or |
| <a href="../LinkState.html#CLOSED"><code>LinkState.CLOSED</code></a>. A link is locally detached after a call to <a href="../Link.html#detach()"><code>Link.detach()</code></a> and |
| is locally closed after a call to <a href="../Endpoint.html#close()"><code>Endpoint.close()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#isLocallyClosedOrDetached()">isLocallyClosedOrDetached</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the link is locally closed or detached.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Endpoint.html#isLocallyOpen()"><code>Endpoint.isLocallyOpen()</code></a>, |
| <a href="../Link.html#isLocallyDetached()"><code>Link.isLocallyDetached()</code></a>, |
| <a href="../Endpoint.html#isLocallyClosed()"><code>Endpoint.isLocallyClosed()</code></a></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="../Link.html#isRemotelyOpen()">Link</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently remotely open meaning the state returned |
| from <a href="../Link.html#getRemoteState()"><code>Link.getRemoteState()</code></a> is equal to <a href="../LinkState.html#ACTIVE"><code>LinkState.ACTIVE</code></a>. A link |
| is remotely opened after an <a href="../../types/transport/Attach.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Attach</code></a> has been received from the remote and before a |
| <a href="../../types/transport/Detach.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Detach</code></a> has been received from the remote.</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#isRemotelyOpen()">isRemotelyOpen</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the link is remotely open.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Link.html#isRemotelyClosed()"><code>Link.isRemotelyClosed()</code></a>, |
| <a href="../Link.html#isRemotelyDetached()"><code>Link.isRemotelyDetached()</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="../Link.html#isRemotelyClosed()">Link</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently remotely closed meaning the state returned |
| from <a href="../Link.html#getRemoteState()"><code>Link.getRemoteState()</code></a> is equal to <a href="../LinkState.html#CLOSED"><code>LinkState.CLOSED</code></a>. A link |
| is remotely closed after an <a href="../../types/transport/Detach.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Detach</code></a> has been received from the remote with the close |
| flag equal to true.</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#isRemotelyClosed()">isRemotelyClosed</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the link is remotely closed.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Link.html#isRemotelyOpen()"><code>Link.isRemotelyOpen()</code></a>, |
| <a href="../Link.html#isRemotelyDetached()"><code>Link.isRemotelyDetached()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRemotelyDetached()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRemotelyDetached</h4> |
| <pre class="methodSignature">public boolean isRemotelyDetached()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#isRemotelyDetached()">Link</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently remotely detached meaning the state returned |
| from <a href="../Link.html#getRemoteState()"><code>Link.getRemoteState()</code></a> is equal to <a href="../LinkState.html#DETACHED"><code>LinkState.DETACHED</code></a>. A link |
| is remotely detached after an <a href="../../types/transport/Detach.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Detach</code></a> has been received from the remote with the close |
| flag equal to false.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#isRemotelyDetached()">isRemotelyDetached</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the link is remotely detached.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Link.html#isRemotelyOpen()"><code>Link.isRemotelyOpen()</code></a>, |
| <a href="../Link.html#isRemotelyClosed()"><code>Link.isRemotelyClosed()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isRemotelyClosedOrDetached()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isRemotelyClosedOrDetached</h4> |
| <pre class="methodSignature">public boolean isRemotelyClosedOrDetached()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#isRemotelyClosedOrDetached()">Link</a></code></span></div> |
| <div class="block">Returns true if this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> is currently remotely detached or closed meaning the state |
| returned from <a href="../Link.html#getRemoteState()"><code>Link.getRemoteState()</code></a> is equal to <a href="../LinkState.html#DETACHED"><code>LinkState.DETACHED</code></a> or |
| <a href="../LinkState.html#CLOSED"><code>LinkState.CLOSED</code></a>. A link is remotely detached or closed after a <a href="../../types/transport/Detach.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Detach</code></a> |
| has been received from the remote.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#isRemotelyClosedOrDetached()">isRemotelyClosedOrDetached</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the link is remotely detached or closed.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Link.html#isRemotelyOpen()"><code>Link.isRemotelyOpen()</code></a>, |
| <a href="../Link.html#isRemotelyClosed()"><code>Link.isRemotelyClosed()</code></a>, |
| <a href="../Link.html#isRemotelyDetached()"><code>Link.isRemotelyDetached()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteSenderSettleMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteSenderSettleMode</h4> |
| <pre class="methodSignature">public <a href="../../types/transport/SenderSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">SenderSettleMode</a> getRemoteSenderSettleMode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#getRemoteSenderSettleMode()">Link</a></code></span></div> |
| <div class="block">Gets the remote link sender settlement mode, as conveyed from the peer via the Attach frame |
| when attaching the link to the session.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getRemoteSenderSettleMode()">getRemoteSenderSettleMode</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sender settlement mode conveyed by the peer, or null if there was none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Link.html#setSenderSettleMode(org.apache.qpid.protonj2.types.transport.SenderSettleMode)"><code>Link.setSenderSettleMode(SenderSettleMode)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteReceiverSettleMode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteReceiverSettleMode</h4> |
| <pre class="methodSignature">public <a href="../../types/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.protonj2.types.transport">ReceiverSettleMode</a> getRemoteReceiverSettleMode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#getRemoteReceiverSettleMode()">Link</a></code></span></div> |
| <div class="block">Gets the remote link receiver settlement mode, as conveyed from the peer via the Attach frame |
| when attaching the link to the session.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getRemoteReceiverSettleMode()">getRemoteReceiverSettleMode</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sender receiver mode conveyed by the peer, or null if there was none.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../Link.html#setReceiverSettleMode(org.apache.qpid.protonj2.types.transport.ReceiverSettleMode)"><code>Link.setReceiverSettleMode(ReceiverSettleMode)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteSource()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteSource</h4> |
| <pre class="methodSignature">public <a href="../../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging">Source</a> getRemoteSource()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getRemoteSource()">getRemoteSource</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the source <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Terminus</code></a> for the remote end of this link.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteTarget()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteTarget</h4> |
| <pre class="methodSignature">public <T extends <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging">Terminus</a>> T getRemoteTarget()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#getRemoteTarget()">Link</a></code></span></div> |
| <div class="block">Returns the remote target <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Terminus</code></a> cast to the given type. This can be used when |
| the underlying type is known by the caller or as a control to validate the assumption of the |
| underlying type. |
| <p> |
| the currently set Target for this <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a>. A link target can be either a <a href="../../types/messaging/Target.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Target</code></a> |
| type for a <a href="../Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> or <a href="../Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> link or if the link is to be transaction resource |
| then the target type will be a <a href="../../types/transactions/Coordinator.html" title="class in org.apache.qpid.protonj2.types.transactions"><code>Coordinator</code></a> instance.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getRemoteTarget()">getRemoteTarget</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type that the remote <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Terminus</code></a> will be cast to on return.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the source <a href="../../types/messaging/Terminus.html" title="interface in org.apache.qpid.protonj2.types.messaging"><code>Terminus</code></a> for the remote end of this link.</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</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="getRemoteMaxMessageSize()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteMaxMessageSize</h4> |
| <pre class="methodSignature">public <a href="../../types/UnsignedLong.html" title="class in org.apache.qpid.protonj2.types">UnsignedLong</a> getRemoteMaxMessageSize()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#getRemoteMaxMessageSize()">Link</a></code></span></div> |
| <div class="block">Gets the remote link max message size, as conveyed from the peer via the Attach frame |
| when attaching the link to the session.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#getRemoteMaxMessageSize()">getRemoteMaxMessageSize</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote max message size conveyed by the peer, or null if none was set. 0 also means no limit.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="localDetachHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localDetachHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> localDetachHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>> localDetachHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#localDetachHandler(org.apache.qpid.protonj2.engine.EventHandler)">Link</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 this link is detached locally via a call to <a href="../Link.html#detach()"><code>Link.detach()</code></a> |
| |
| This is a convenience event that supplements the normal <a href="../Endpoint.html#localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)"><code>Endpoint.localCloseHandler(EventHandler)</code></a> |
| event point if set. If no local detached event handler is set the endpoint will route the detached event |
| to the local closed event handler if set and allow it to process the event in one location. |
| <p> |
| Typically used by clients for logging or other state update event processing. Clients should not perform any |
| blocking calls within this context. It is an error for the handler to throw an exception and the outcome of |
| doing so is undefined.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#localDetachHandler(org.apache.qpid.protonj2.engine.EventHandler)">localDetachHandler</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localDetachHandler</code> - The <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> to notify when this link is locally detached.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the link for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="detachHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>detachHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> detachHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>> remoteDetachHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#detachHandler(org.apache.qpid.protonj2.engine.EventHandler)">Link</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 Detach frame is received from the remote peer for this |
| <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> which would have been locally opened previously, the Detach from would have been marked |
| as not having been closed. |
| <p> |
| This is a convenience event that supplements the normal <a href="../Endpoint.html#closeHandler(org.apache.qpid.protonj2.engine.EventHandler)"><code>Endpoint.closeHandler(EventHandler)</code></a> |
| event point if set. If no detached event handler is set the endpoint will route the detached event to the |
| closed event handler if set and allow it to process the event in one location.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#detachHandler(org.apache.qpid.protonj2.engine.EventHandler)">detachHandler</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteDetachHandler</code> - The <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> to notify when this link is remotely closed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine"><code>Link</code></a> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="parentEndpointClosedHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parentEndpointClosedHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> parentEndpointClosedHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>> handler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Link.html#parentEndpointClosedHandler(org.apache.qpid.protonj2.engine.EventHandler)">Link</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 the parent <a href="../Session.html" title="interface in org.apache.qpid.protonj2.engine"><code>Session</code></a> or <a href="../Connection.html" title="interface in org.apache.qpid.protonj2.engine"><code>Connection</code></a> of this link is |
| locally closed. |
| <p> |
| Typically used by clients for logging or other state update event processing. Clients should not perform any |
| blocking calls within this context. It is an error for the handler to throw an exception and the outcome of |
| doing so is undefined.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Link.html#parentEndpointClosedHandler(org.apache.qpid.protonj2.engine.EventHandler)">parentEndpointClosedHandler</a></code> in interface <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><<a href="ProtonLink.html" title="type parameter in ProtonLink">L</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>handler</code> - The <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> to notify when this link's parent Session is locally closed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the link for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="transitionedToLocallyOpened()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transitionedToLocallyOpened</h4> |
| <pre class="methodSignature">protected void transitionedToLocallyOpened()</pre> |
| </li> |
| </ul> |
| <a id="transitionedToLocallyDetached()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transitionedToLocallyDetached</h4> |
| <pre class="methodSignature">protected void transitionedToLocallyDetached()</pre> |
| </li> |
| </ul> |
| <a id="transitionedToLocallyClosed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transitionedToLocallyClosed</h4> |
| <pre class="methodSignature">protected void transitionedToLocallyClosed()</pre> |
| </li> |
| </ul> |
| <a id="transitionToRemotelyOpenedState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transitionToRemotelyOpenedState</h4> |
| <pre class="methodSignature">protected void transitionToRemotelyOpenedState()</pre> |
| </li> |
| </ul> |
| <a id="transitionToRemotelyDetached()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transitionToRemotelyDetached</h4> |
| <pre class="methodSignature">protected void transitionToRemotelyDetached()</pre> |
| </li> |
| </ul> |
| <a id="transitionToRemotelyClosed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transitionToRemotelyClosed</h4> |
| <pre class="methodSignature">protected void transitionToRemotelyClosed()</pre> |
| </li> |
| </ul> |
| <a id="transitionToParentLocallyClosed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transitionToParentLocallyClosed</h4> |
| <pre class="methodSignature">protected void transitionToParentLocallyClosed()</pre> |
| </li> |
| </ul> |
| <a id="transitionToParentRemotelyClosed()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>transitionToParentRemotelyClosed</h4> |
| <pre class="methodSignature">protected void transitionToParentRemotelyClosed()</pre> |
| </li> |
| </ul> |
| <a id="handleRemoteAttach(org.apache.qpid.protonj2.types.transport.Attach)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleRemoteAttach</h4> |
| <pre class="methodSignature">protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> handleRemoteAttach​(<a href="../../types/transport/Attach.html" title="class in org.apache.qpid.protonj2.types.transport">Attach</a> attach)</pre> |
| </li> |
| </ul> |
| <a id="handleRemoteDetach(org.apache.qpid.protonj2.types.transport.Detach)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleRemoteDetach</h4> |
| <pre class="methodSignature">protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> handleRemoteDetach​(<a href="../../types/transport/Detach.html" title="class in org.apache.qpid.protonj2.types.transport">Detach</a> detach)</pre> |
| </li> |
| </ul> |
| <a id="handleRemoteFlow(org.apache.qpid.protonj2.types.transport.Flow)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleRemoteFlow</h4> |
| <pre class="methodSignature">protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> handleRemoteFlow​(<a href="../../types/transport/Flow.html" title="class in org.apache.qpid.protonj2.types.transport">Flow</a> flow)</pre> |
| </li> |
| </ul> |
| <a id="handleRemoteDisposition(org.apache.qpid.protonj2.types.transport.Disposition,org.apache.qpid.protonj2.engine.impl.ProtonOutgoingDelivery)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleRemoteDisposition</h4> |
| <pre class="methodSignature">protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> handleRemoteDisposition​(<a href="../../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport">Disposition</a> disposition, |
| <a href="ProtonOutgoingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonOutgoingDelivery</a> delivery)</pre> |
| </li> |
| </ul> |
| <a id="handleRemoteDisposition(org.apache.qpid.protonj2.types.transport.Disposition,org.apache.qpid.protonj2.engine.impl.ProtonIncomingDelivery)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleRemoteDisposition</h4> |
| <pre class="methodSignature">protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> handleRemoteDisposition​(<a href="../../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport">Disposition</a> disposition, |
| <a href="ProtonIncomingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonIncomingDelivery</a> delivery)</pre> |
| </li> |
| </ul> |
| <a id="handleRemoteTransfer(org.apache.qpid.protonj2.types.transport.Transfer,org.apache.qpid.protonj2.buffer.ProtonBuffer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleRemoteTransfer</h4> |
| <pre class="methodSignature">protected abstract <a href="ProtonIncomingDelivery.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonIncomingDelivery</a> handleRemoteTransfer​(<a href="../../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport">Transfer</a> transfer, |
| <a href="../../buffer/ProtonBuffer.html" title="interface in org.apache.qpid.protonj2.buffer">ProtonBuffer</a> payload)</pre> |
| </li> |
| </ul> |
| <a id="decorateOutgoingFlow(org.apache.qpid.protonj2.types.transport.Flow)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decorateOutgoingFlow</h4> |
| <pre class="methodSignature">protected abstract <a href="ProtonLink.html" title="type parameter in ProtonLink">L</a> decorateOutgoingFlow​(<a href="../../types/transport/Flow.html" title="class in org.apache.qpid.protonj2.types.transport">Flow</a> flow)</pre> |
| </li> |
| </ul> |
| <a id="checkLinkOperable(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkLinkOperable</h4> |
| <pre class="methodSignature">protected void checkLinkOperable​(<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> failurePrefix)</pre> |
| </li> |
| </ul> |
| <a id="areDeliveriesStillActive()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>areDeliveriesStillActive</h4> |
| <pre class="methodSignature">protected boolean areDeliveriesStillActive()</pre> |
| </li> |
| </ul> |
| <a id="checkNotOpened(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkNotOpened</h4> |
| <pre class="methodSignature">protected void checkNotOpened​(<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> errorMessage)</pre> |
| </li> |
| </ul> |
| <a id="checkNotClosed(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>checkNotClosed</h4> |
| <pre class="methodSignature">protected void checkNotClosed​(<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> errorMessage)</pre> |
| </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/ProtonLink.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><a href="#field.detail">Field</a> | </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> |
