| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Wed May 12 10:10:59 EDT 2021 --> |
| <title>ProtonEndpoint (Qpid ProtonJ2 Parent 1.0.0-M1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-05-12"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ProtonEndpoint (Qpid ProtonJ2 Parent 1.0.0-M1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</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/ProtonEndpoint.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="../../../../../../index-all.html">Index</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> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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 ProtonEndpoint" class="title">Class ProtonEndpoint<E extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><E>></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.qpid.protonj2.engine.impl.ProtonEndpoint<E></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>E</code> - The specific <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> type this abstract type implements.</dd> |
| </dl> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><E></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="ProtonConnection.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonConnection</a></code>, <code><a href="ProtonLink.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonLink</a></code>, <code><a href="ProtonSession.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonSession</a></code>, <code><a href="ProtonTransactionController.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonTransactionController</a></code>, <code><a href="ProtonTransactionManager.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonTransactionManager</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">ProtonEndpoint<E extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><E>></span> |
| extends java.lang.Object |
| implements <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><E></pre> |
| <div class="block">Proton abstract <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> implementation that provides some common facilities.</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="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#engine">engine</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.qpid.protonj2.engine.impl.ProtonEngine)">ProtonEndpoint</a></span>​(<a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a> engine)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new <a href="ProtonEndpoint.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonEndpoint</code></a> instance with the given Engine as the owner.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeHandler(org.apache.qpid.protonj2.engine.EventHandler)">closeHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>> remoteCloseEventHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a EventHandler for when an AMQP Close frame is received from the remote peer.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)">engineShutdownHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a>> engineShutdownEventHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets an <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> that is invoked when the engine that supports this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is shutdown |
| via a call to <a href="../Engine.html#shutdown()"><code>Engine.shutdown()</code></a> which indicates a desire to terminate all engine operations.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonAttachments.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonAttachments</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttachments()">getAttachments</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCondition()">getCondition</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEngine()">getEngine</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLinkedResource()">getLinkedResource</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLinkedResource(java.lang.Class)">getLinkedResource</a></span>​(java.lang.Class<T> typeClass)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteCondition()">getRemoteCondition</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If the remote has closed this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> and provided an <a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> as part |
| of the closing AMQP performative then this method will return it.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)">localCloseHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>> localCloseEventHandler)</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 <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is closed locally via a call to <a href="../Endpoint.html#close()"><code>Endpoint.close()</code></a> |
| |
| Typically used by clients for logging or other state update event processing.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">localOpenHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>> localOpenEventHandler)</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 <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened locally via a call to <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a> |
| |
| Typically used by clients for logging or other state update event processing.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openHandler(org.apache.qpid.protonj2.engine.EventHandler)">openHandler</a></span>​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>> remoteOpenEventHandler)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a EventHandler for when an AMQP Open frame is received from the remote peer.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)">setCondition</a></span>​(<a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a> condition)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the local <a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> to be applied to a <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> close.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLinkedResource(java.lang.Object)">setLinkedResource</a></span>​(java.lang.Object resource)</code></th> |
| <td class="colLast"> |
| <div class="block">Links a given resource to this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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#close()">close</a>, <a href="../Endpoint.html#getDesiredCapabilities()">getDesiredCapabilities</a>, <a href="../Endpoint.html#getOfferedCapabilities()">getOfferedCapabilities</a>, <a href="../Endpoint.html#getParent()">getParent</a>, <a href="../Endpoint.html#getProperties()">getProperties</a>, <a href="../Endpoint.html#getRemoteDesiredCapabilities()">getRemoteDesiredCapabilities</a>, <a href="../Endpoint.html#getRemoteOfferedCapabilities()">getRemoteOfferedCapabilities</a>, <a href="../Endpoint.html#getRemoteProperties()">getRemoteProperties</a>, <a href="../Endpoint.html#isLocallyClosed()">isLocallyClosed</a>, <a href="../Endpoint.html#isLocallyOpen()">isLocallyOpen</a>, <a href="../Endpoint.html#isRemotelyClosed()">isRemotelyClosed</a>, <a href="../Endpoint.html#isRemotelyOpen()">isRemotelyOpen</a>, <a href="../Endpoint.html#open()">open</a>, <a href="../Endpoint.html#setDesiredCapabilities(org.apache.qpid.protonj2.types.Symbol...)">setDesiredCapabilities</a>, <a href="../Endpoint.html#setOfferedCapabilities(org.apache.qpid.protonj2.types.Symbol...)">setOfferedCapabilities</a>, <a href="../Endpoint.html#setProperties(java.util.Map)">setProperties</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="engine"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>engine</h4> |
| <pre>protected final <a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a> engine</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.ProtonEngine)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ProtonEndpoint</h4> |
| <pre>public ProtonEndpoint​(<a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a> engine)</pre> |
| <div class="block">Create a new <a href="ProtonEndpoint.html" title="class in org.apache.qpid.protonj2.engine.impl"><code>ProtonEndpoint</code></a> instance with the given Engine as the owner.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>engine</code> - The <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a> that this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> belongs to.</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="setLinkedResource(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLinkedResource</h4> |
| <pre class="methodSignature">public <a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> setLinkedResource​(java.lang.Object resource)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#setLinkedResource(java.lang.Object)">Endpoint</a></code></span></div> |
| <div class="block">Links a given resource to this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#setLinkedResource(java.lang.Object)">setLinkedResource</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - The resource to link to this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>.</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="getLinkedResource()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLinkedResource</h4> |
| <pre class="methodSignature">public <T> T getLinkedResource()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getLinkedResource()">getLinkedResource</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type that the linked resource should be cast to on return.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user set linked resource for this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLinkedResource(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLinkedResource</h4> |
| <pre class="methodSignature">public <T> T getLinkedResource​(java.lang.Class<T> typeClass)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#getLinkedResource(java.lang.Class)">Endpoint</a></code></span></div> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getLinkedResource(java.lang.Class)">getLinkedResource</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - The type to cast the linked resource to if one is set.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>typeClass</code> - the type's Class which is used for casting the returned value.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user set linked resource for this Context instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEngine()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEngine</h4> |
| <pre class="methodSignature">public <a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a> getEngine()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getEngine()">getEngine</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a> which created this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttachments()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttachments</h4> |
| <pre class="methodSignature">public <a href="ProtonAttachments.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonAttachments</a> getAttachments()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getAttachments()">getAttachments</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../Attachments.html" title="interface in org.apache.qpid.protonj2.engine"><code>Attachments</code></a> instance that is associated with this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCondition()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCondition</h4> |
| <pre class="methodSignature">public <a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a> getCondition()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getCondition()">getCondition</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the local <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> error, or null if there is none</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCondition</h4> |
| <pre class="methodSignature">public <a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> setCondition​(<a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a> condition)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)">Endpoint</a></code></span></div> |
| <div class="block">Sets the local <a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> to be applied to a <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> close.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)">setCondition</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>condition</code> - The error condition to convey to the remote peer on close of this end point.</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="getRemoteCondition()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteCondition</h4> |
| <pre class="methodSignature">public <a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a> getRemoteCondition()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#getRemoteCondition()">Endpoint</a></code></span></div> |
| <div class="block">If the remote has closed this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> and provided an <a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a> as part |
| of the closing AMQP performative then this method will return it.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#getRemoteCondition()">getRemoteCondition</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the remote supplied <a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>ErrorCondition</code></a>, or null if there is none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="openHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> openHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>> remoteOpenEventHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#openHandler(org.apache.qpid.protonj2.engine.EventHandler)">Endpoint</a></code></span></div> |
| <div class="block">Sets a EventHandler for when an AMQP Open frame is received from the remote peer. |
| |
| Used to process remotely initiated Connections. Locally initiated sessions have their own EventHandler |
| invoked instead. This method is typically used by servers to listen for the remote peer to open its |
| <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>, while a client would listen for the server to open its end of the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> once |
| a local open has been performed. |
| |
| Typically used by clients as servers will typically listen to some parent resource event handler |
| to determine if the remote is initiating a resource open.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#openHandler(org.apache.qpid.protonj2.engine.EventHandler)">openHandler</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteOpenEventHandler</code> - the EventHandler that will be signaled when the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> has been remotely 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="closeHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>closeHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> closeHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>> remoteCloseEventHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#closeHandler(org.apache.qpid.protonj2.engine.EventHandler)">Endpoint</a></code></span></div> |
| <div class="block">Sets a EventHandler for when an AMQP Close frame is received from the remote peer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#closeHandler(org.apache.qpid.protonj2.engine.EventHandler)">closeHandler</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>remoteCloseEventHandler</code> - the EventHandler that will be signaled when the <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is remotely closed.</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="localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localOpenHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> localOpenHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>> localOpenEventHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">Endpoint</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 <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is opened locally via a call to <a href="../Endpoint.html#open()"><code>Endpoint.open()</code></a> |
| |
| 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="../Endpoint.html#localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)">localOpenHandler</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localOpenEventHandler</code> - The <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> to notify when this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is locally 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="localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>localCloseHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> localCloseHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>> localCloseEventHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)">Endpoint</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 <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is closed locally via a call to <a href="../Endpoint.html#close()"><code>Endpoint.close()</code></a> |
| |
| 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="../Endpoint.html#localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)">localCloseHandler</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>localCloseEventHandler</code> - The <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> to notify when this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is locally closed.</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="engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>engineShutdownHandler</h4> |
| <pre class="methodSignature">public <a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> engineShutdownHandler​(<a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><<a href="../Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a>> engineShutdownEventHandler)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Endpoint.html#engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)">Endpoint</a></code></span></div> |
| <div class="block">Sets an <a href="../EventHandler.html" title="interface in org.apache.qpid.protonj2.engine"><code>EventHandler</code></a> that is invoked when the engine that supports this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> is shutdown |
| via a call to <a href="../Engine.html#shutdown()"><code>Engine.shutdown()</code></a> which indicates a desire to terminate all engine operations. Any |
| <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> that has been both locally and remotely closed will not receive this event as it will no longer |
| be tracked by the parent its parent <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>. |
| |
| A typical use of this event would be from a locally closed <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> that is awaiting response from |
| the remote. If this event fires then there will never be a remote response to any pending operations and |
| the client or server instance should react accordingly to clean up any related resources etc.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../Endpoint.html#engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)">engineShutdownHandler</a></code> in interface <code><a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a> extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><<a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a>>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>engineShutdownEventHandler</code> - the EventHandler that will be signaled when this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a>'s engine is explicitly shutdown.</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> |
| </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/ProtonEndpoint.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="../../../../../../index-all.html">Index</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 © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |