| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.qpid.protonj2.engine (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"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body class="package-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 class="nav-bar-cell1-rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../help-doc.html#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li>Description | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <h1 title="Package org.apache.qpid.protonj2.engine" class="title">Package org.apache.qpid.protonj2.engine</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.qpid.protonj2.engine</span></div> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="exceptions/package-summary.html">org.apache.qpid.protonj2.engine.exceptions</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="impl/package-summary.html">org.apache.qpid.protonj2.engine.impl</a></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><a href="sasl/package-summary.html">org.apache.qpid.protonj2.engine.sasl</a></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><a href="util/package-summary.html">org.apache.qpid.protonj2.engine.util</a></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="AMQPPerformativeEnvelopePool.html" title="class in org.apache.qpid.protonj2.engine">AMQPPerformativeEnvelopePool</a><E extends <a href="PerformativeEnvelope.html" title="class in org.apache.qpid.protonj2.engine">PerformativeEnvelope</a><<a href="../types/transport/Performative.html" title="interface in org.apache.qpid.protonj2.types.transport">Performative</a>>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Pool of <a href="PerformativeEnvelope.html" title="class in org.apache.qpid.protonj2.engine"><code>PerformativeEnvelope</code></a> instances used to reduce allocations on incoming performatives.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine">Attachments</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Attachments API used to associate specific data with AMQP Resources</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">AMQP Connection state container</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="ConnectionState.html" title="enum in org.apache.qpid.protonj2.engine">ConnectionState</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Represents the state of an AMQP Connection.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine">DeliveryTagGenerator</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Transfer tag generators can be assigned to <a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> links in order to |
| allow the link to automatically assign a transfer tag to each outbound delivery.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="EmptyEnvelope.html" title="class in org.apache.qpid.protonj2.engine">EmptyEnvelope</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">An empty envelope which can be used to drive transport activity when idle.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><E extends <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><E>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Represents a conceptual endpoint type used to provide common operations that |
| all the endpoint types will share.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">AMQP Engine interface.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Configuration options for the Engine</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="EngineFactory.html" title="interface in org.apache.qpid.protonj2.engine">EngineFactory</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Interface used to define the basic mechanisms for creating Engine instances.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Listen for events generated from the Engine</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Context provided to EngineHandler events to allow further event propagation</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Pipeline of handlers for Engine work.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="EngineSaslDriver.html" title="interface in org.apache.qpid.protonj2.engine">EngineSaslDriver</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Driver for the Engine that exposes SASL state and configuration.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="EngineSaslDriver.SaslState.html" title="enum in org.apache.qpid.protonj2.engine">EngineSaslDriver.SaslState</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">The SASL driver state used to determine at what point the current SASL negotiation process |
| is currently in.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="EngineState.html" title="enum in org.apache.qpid.protonj2.engine">EngineState</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Enumeration of Engine states as visible from the Engine API</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><E></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Handler of events from the proton resources.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine">HeaderEnvelope</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Envelope type that carries AMQPHeader instances</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="IncomingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">IncomingAMQPEnvelope</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Frame object that carries an AMQP Performative</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="IncomingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">IncomingDelivery</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">API for an incoming Delivery.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><L extends <a href="Link.html" title="interface in org.apache.qpid.protonj2.engine">Link</a><L>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Base API for <a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine"><code>Sender</code></a> and <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.engine"><code>Receiver</code></a> links.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LinkCreditState.html" title="interface in org.apache.qpid.protonj2.engine">LinkCreditState</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">State object holding information about the current link credit</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="LinkState.html" title="enum in org.apache.qpid.protonj2.engine">LinkState</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">Represents the state of an AMQP Link.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">OutgoingAMQPEnvelope</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Frame object that carries an AMQP Performative</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">API for an outgoing Delivery.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PerformativeEnvelope.html" title="class in org.apache.qpid.protonj2.engine">PerformativeEnvelope</a><V></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Base class for envelope types that travel through the engine.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.engine">Receiver</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">AMQP Receiver API</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Frame object containing a SASL performative</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Scheduler.html" title="interface in org.apache.qpid.protonj2.engine">Scheduler</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A basic scheduling service API that does not provide the full <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/ScheduledExecutorService.html" title="class or interface in java.util.concurrent" class="external-link"><code>ScheduledExecutorService</code></a> |
| API which is generally not needed by the proton <a href="Engine.html" title="interface in org.apache.qpid.protonj2.engine"><code>Engine</code></a> and might not be provided by |
| the component provided to the engine which performs scheduled services.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">AMQP Sender API</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">AMQP Session interface</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="SessionState.html" title="enum in org.apache.qpid.protonj2.engine">SessionState</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Represents the state of an AMQP Session.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine">Transaction</a><E extends <a href="Endpoint.html" title="interface in org.apache.qpid.protonj2.engine">Endpoint</a><?>></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A Transaction object that hold information and context for a single <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="Transaction.DischargeState.html" title="enum in org.apache.qpid.protonj2.engine">Transaction.DischargeState</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Provides state for this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TransactionController.html" title="interface in org.apache.qpid.protonj2.engine">TransactionController</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Transaction Controller link that implements the mechanics of declaring and discharging |
| AMQP transactions.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine">TransactionManager</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Transaction Manager endpoint that implements the mechanics of handling the declaration |
| of and the requested discharge of AMQP transactions.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="TransactionState.html" title="enum in org.apache.qpid.protonj2.engine">TransactionState</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">Indicates the current state of a given <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a></div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </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> |
