| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.qpid.protonj2.engine (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.qpid.protonj2.engine (Qpid ProtonJ2 Parent 1.0.0-M9 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">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="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <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> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.qpid.protonj2.engine</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Attachments.html" title="interface in org.apache.qpid.protonj2.engine">Attachments</a></th> |
| <td class="colLast"> |
| <div class="block">Attachments API used to associate specific data with AMQP Resources</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Connection.html" title="interface in org.apache.qpid.protonj2.engine">Connection</a></th> |
| <td class="colLast"> |
| <div class="block">AMQP Connection state container</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DeliveryTagGenerator.html" title="interface in org.apache.qpid.protonj2.engine">DeliveryTagGenerator</a></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><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>></th> |
| <td class="colLast"> |
| <div class="block">Represents a conceptual endpoint type used to provide common operations that |
| all the endpoint types will share.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Engine.html" title="interface in org.apache.qpid.protonj2.engine">Engine</a></th> |
| <td class="colLast"> |
| <div class="block">AMQP Engine interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EngineConfiguration.html" title="interface in org.apache.qpid.protonj2.engine">EngineConfiguration</a></th> |
| <td class="colLast"> |
| <div class="block">Configuration options for the Engine</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EngineFactory.html" title="interface in org.apache.qpid.protonj2.engine">EngineFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Interface used to define the basic mechanisms for creating Engine instances.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EngineHandler.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandler</a></th> |
| <td class="colLast"> |
| <div class="block">Listen for events generated from the Engine</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EngineHandlerContext.html" title="interface in org.apache.qpid.protonj2.engine">EngineHandlerContext</a></th> |
| <td class="colLast"> |
| <div class="block">Context provided to EngineHandler events to allow further event propagation</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EnginePipeline.html" title="interface in org.apache.qpid.protonj2.engine">EnginePipeline</a></th> |
| <td class="colLast"> |
| <div class="block">Pipeline of handlers for Engine work.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EngineSaslDriver.html" title="interface in org.apache.qpid.protonj2.engine">EngineSaslDriver</a></th> |
| <td class="colLast"> |
| <div class="block">Driver for the Engine that exposes SASL state and configuration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EventHandler.html" title="interface in org.apache.qpid.protonj2.engine">EventHandler</a><E></th> |
| <td class="colLast"> |
| <div class="block">Handler of events from the proton resources.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="IncomingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">IncomingDelivery</a></th> |
| <td class="colLast"> |
| <div class="block">API for an incoming Delivery.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><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>></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="LinkCreditState.html" title="interface in org.apache.qpid.protonj2.engine">LinkCreditState</a></th> |
| <td class="colLast"> |
| <div class="block">State object holding information about the current link credit</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="OutgoingDelivery.html" title="interface in org.apache.qpid.protonj2.engine">OutgoingDelivery</a></th> |
| <td class="colLast"> |
| <div class="block">API for an outgoing Delivery.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.engine">Receiver</a></th> |
| <td class="colLast"> |
| <div class="block">AMQP Receiver API</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a></th> |
| <td class="colLast"> |
| <div class="block">AMQP Sender API</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Session.html" title="interface in org.apache.qpid.protonj2.engine">Session</a></th> |
| <td class="colLast"> |
| <div class="block">AMQP Session interface</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><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><?>></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="TransactionController.html" title="interface in org.apache.qpid.protonj2.engine">TransactionController</a></th> |
| <td class="colLast"> |
| <div class="block">Transaction Controller link that implements the mechanics of declaring and discharging |
| AMQP transactions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="TransactionManager.html" title="interface in org.apache.qpid.protonj2.engine">TransactionManager</a></th> |
| <td class="colLast"> |
| <div class="block">Transaction Manager endpoint that implements the mechanics of handling the declaration |
| of and the requested discharge of AMQP transactions.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><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>>></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EmptyEnvelope.html" title="class in org.apache.qpid.protonj2.engine">EmptyEnvelope</a></th> |
| <td class="colLast"> |
| <div class="block">An empty envelope which can be used to drive transport activity when idle.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="HeaderEnvelope.html" title="class in org.apache.qpid.protonj2.engine">HeaderEnvelope</a></th> |
| <td class="colLast"> |
| <div class="block">Envelope type that carries AMQPHeader instances</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="IncomingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">IncomingAMQPEnvelope</a></th> |
| <td class="colLast"> |
| <div class="block">Frame object that carries an AMQP Performative</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="OutgoingAMQPEnvelope.html" title="class in org.apache.qpid.protonj2.engine">OutgoingAMQPEnvelope</a></th> |
| <td class="colLast"> |
| <div class="block">Frame object that carries an AMQP Performative</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="PerformativeEnvelope.html" title="class in org.apache.qpid.protonj2.engine">PerformativeEnvelope</a><V></th> |
| <td class="colLast"> |
| <div class="block">Base class for envelope types that travel through the engine.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SASLEnvelope.html" title="class in org.apache.qpid.protonj2.engine">SASLEnvelope</a></th> |
| <td class="colLast"> |
| <div class="block">Frame object containing a SASL performative</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ConnectionState.html" title="enum in org.apache.qpid.protonj2.engine">ConnectionState</a></th> |
| <td class="colLast"> |
| <div class="block">Represents the state of an AMQP Connection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="EngineSaslDriver.SaslState.html" title="enum in org.apache.qpid.protonj2.engine">EngineSaslDriver.SaslState</a></th> |
| <td class="colLast"> |
| <div class="block">The SASL driver state used to determine at what point the current SASL negotiation process |
| is currently in.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="EngineState.html" title="enum in org.apache.qpid.protonj2.engine">EngineState</a></th> |
| <td class="colLast"> |
| <div class="block">Enumeration of Engine states as visible from the Engine API</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="LinkState.html" title="enum in org.apache.qpid.protonj2.engine">LinkState</a></th> |
| <td class="colLast"> |
| <div class="block">Represents the state of an AMQP Link.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SessionState.html" title="enum in org.apache.qpid.protonj2.engine">SessionState</a></th> |
| <td class="colLast"> |
| <div class="block">Represents the state of an AMQP Session.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Transaction.DischargeState.html" title="enum in org.apache.qpid.protonj2.engine">Transaction.DischargeState</a></th> |
| <td class="colLast"> |
| <div class="block">Provides state for this <a href="Transaction.html" title="interface in org.apache.qpid.protonj2.engine"><code>Transaction</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="TransactionState.html" title="enum in org.apache.qpid.protonj2.engine">TransactionState</a></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <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 class="navBarCell1Rev">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="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
