| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ProtonEndpoint (Qpid ProtonJ2 Parent 1.0.0-M19 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.qpid.protonj2.engine.impl, class: ProtonEndpoint"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ProtonEndpoint.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <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> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.qpid.protonj2.engine.impl</a></div> |
| <h1 title="Class ProtonEndpoint" class="title">Class ProtonEndpoint<E extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><E>></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.qpid.protonj2.engine.impl.ProtonEndpoint<E></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</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 class="notes"> |
| <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 class="notes"> |
| <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> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ProtonEndpoint<E extends <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><E>></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><E></span></div> |
| <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> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected final <a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#engine" class="member-name-link">engine</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.qpid.protonj2.engine.impl.ProtonEngine)" class="member-name-link">ProtonEndpoint</a><wbr>(<a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a> engine)</code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#closeHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">closeHandler</a><wbr>(<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></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a EventHandler for when an AMQP Close frame is received from the remote peer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">engineShutdownHandler</a><wbr>(<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></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonAttachments.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonAttachments</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAttachments()" class="member-name-link">getAttachments</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCondition()" class="member-name-link">getCondition</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEngine()" class="member-name-link">getEngine</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLinkedResource()" class="member-name-link">getLinkedResource</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLinkedResource(java.lang.Class)" class="member-name-link">getLinkedResource</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> typeClass)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the linked resource (if set) and returns it using the type information |
| provided to cast the returned value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRemoteCondition()" class="member-name-link">getRemoteCondition</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">localCloseHandler</a><wbr>(<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></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">localOpenHandler</a><wbr>(<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></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#openHandler(org.apache.qpid.protonj2.engine.EventHandler)" class="member-name-link">openHandler</a><wbr>(<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></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a EventHandler for when an AMQP Open frame is received from the remote peer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)" class="member-name-link">setCondition</a><wbr>(<a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a> condition)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLinkedResource(java.lang.Object)" class="member-name-link">setLinkedResource</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> resource)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.engine.Endpoint">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></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="engine"> |
| <h3>engine</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a></span> <span class="element-name">engine</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.qpid.protonj2.engine.impl.ProtonEngine)"> |
| <h3>ProtonEndpoint</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ProtonEndpoint</span><wbr><span class="parameters">(<a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a> engine)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setLinkedResource(java.lang.Object)"> |
| <h3>setLinkedResource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></span> <span class="element-name">setLinkedResource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> resource)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</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>Returns:</dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLinkedResource()"> |
| <h3>getLinkedResource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getLinkedResource</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</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>Type Parameters:</dt> |
| <dd><code>T</code> - The type that the linked resource should be cast to on return.</dd> |
| <dt>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLinkedResource(java.lang.Class)"> |
| <h3>getLinkedResource</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">getLinkedResource</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> typeClass)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Type Parameters:</dt> |
| <dd><code>T</code> - The type to cast the linked resource to if one is set.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>typeClass</code> - the type's Class which is used for casting the returned value.</dd> |
| <dt>Returns:</dt> |
| <dd>the user set linked resource for this Context instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEngine()"> |
| <h3>getEngine</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEngine.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonEngine</a></span> <span class="element-name">getEngine</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</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>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAttachments()"> |
| <h3>getAttachments</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonAttachments.html" title="class in org.apache.qpid.protonj2.engine.impl">ProtonAttachments</a></span> <span class="element-name">getAttachments</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</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>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCondition()"> |
| <h3>getCondition</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></span> <span class="element-name">getCondition</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</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>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCondition(org.apache.qpid.protonj2.types.transport.ErrorCondition)"> |
| <h3>setCondition</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></span> <span class="element-name">setCondition</span><wbr><span class="parameters">(<a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a> condition)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>condition</code> - The error condition to convey to the remote peer on close of this end point.</dd> |
| <dt>Returns:</dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteCondition()"> |
| <h3>getRemoteCondition</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../types/transport/ErrorCondition.html" title="class in org.apache.qpid.protonj2.types.transport">ErrorCondition</a></span> <span class="element-name">getRemoteCondition</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="openHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>openHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></span> <span class="element-name">openHandler</span><wbr><span class="parameters">(<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)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</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>Returns:</dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="closeHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>closeHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></span> <span class="element-name">closeHandler</span><wbr><span class="parameters">(<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)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</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>Returns:</dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="localOpenHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>localOpenHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></span> <span class="element-name">localOpenHandler</span><wbr><span class="parameters">(<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)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</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>Returns:</dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="localCloseHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>localCloseHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></span> <span class="element-name">localCloseHandler</span><wbr><span class="parameters">(<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)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</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>Returns:</dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="engineShutdownHandler(org.apache.qpid.protonj2.engine.EventHandler)"> |
| <h3>engineShutdownHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ProtonEndpoint.html" title="type parameter in ProtonEndpoint">E</a></span> <span class="element-name">engineShutdownHandler</span><wbr><span class="parameters">(<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)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</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>Returns:</dt> |
| <dd>this <a href="../Endpoint.html" title="interface in org.apache.qpid.protonj2.engine"><code>Endpoint</code></a> instance.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
