Google Git
Sign in
apache / qpid-site / 2a732cdefd1763908e5fef45e6fc60b5973cb84a / . / content / releases / qpid-proton-j-0.24.0 / api / org / apache / qpid / proton / engine / package-summary.html
blob: 31bc22909bd3b80c0f410fb6987d1be94020f518 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.qpid.proton.engine (Qpid Proton-J API)</title>
<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.proton.engine (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</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">
<li><a href="../../../../../org/apache/qpid/proton/codec/transport/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/impl/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/engine/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.qpid.proton.engine</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Collector.html" title="interface in org.apache.qpid.proton.engine">Collector</a></td>
<td class="colLast">
<div class="block">Collector</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Connection.html" title="interface in org.apache.qpid.proton.engine">Connection</a></td>
<td class="colLast">
<div class="block">Maintains lists of sessions, links and deliveries in a state
that is interesting to the application.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/CoreHandler.html" title="interface in org.apache.qpid.proton.engine">CoreHandler</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></td>
<td class="colLast">
<div class="block">A delivery of a message on a particular link.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine">Endpoint</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Event.html" title="interface in org.apache.qpid.proton.engine">Event</a></td>
<td class="colLast">
<div class="block">Event</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/EventType.html" title="interface in org.apache.qpid.proton.engine">EventType</a></td>
<td class="colLast">
<div class="block">Entry point for external libraries to add event types.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></td>
<td class="colLast">
<div class="block">Extendable</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Handler.html" title="interface in org.apache.qpid.proton.engine">Handler</a></td>
<td class="colLast">
<div class="block">Handler</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine">Link</a></td>
<td class="colLast">
<div class="block">Link
The settlement mode defaults are:
Sender settle mode - <a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html#MIXED"><code>SenderSettleMode.MIXED</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/ProtonJConnection.html" title="interface in org.apache.qpid.proton.engine">ProtonJConnection</a></td>
<td class="colLast">
<div class="block">Extends <a href="../../../../../org/apache/qpid/proton/engine/Connection.html" title="interface in org.apache.qpid.proton.engine"><code>Connection</code></a> with functionality that is specific to proton-j</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/ProtonJEndpoint.html" title="interface in org.apache.qpid.proton.engine">ProtonJEndpoint</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/ProtonJSession.html" title="interface in org.apache.qpid.proton.engine">ProtonJSession</a></td>
<td class="colLast">
<div class="block">Extends <a href="../../../../../org/apache/qpid/proton/engine/Session.html" title="interface in org.apache.qpid.proton.engine"><code>Session</code></a> with functionality that is specific to proton-j</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/ProtonJSslDomain.html" title="interface in org.apache.qpid.proton.engine">ProtonJSslDomain</a></td>
<td class="colLast">
<div class="block">Extends <a href="../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine"><code>SslDomain</code></a> with functionality that is specific to proton-j</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/ProtonJSslPeerDetails.html" title="interface in org.apache.qpid.proton.engine">ProtonJSslPeerDetails</a></td>
<td class="colLast">
<div class="block">Extends <a href="../../../../../org/apache/qpid/proton/engine/SslPeerDetails.html" title="interface in org.apache.qpid.proton.engine"><code>SslPeerDetails</code></a> with functionality specific to proton-j</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/ProtonJTransport.html" title="interface in org.apache.qpid.proton.engine">ProtonJTransport</a></td>
<td class="colLast">
<div class="block">Extends <a href="../../../../../org/apache/qpid/proton/engine/Transport.html" title="interface in org.apache.qpid.proton.engine"><code>Transport</code></a> with functionality that is specific to proton-j</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a></td>
<td class="colLast">
<div class="block">Receiver</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Record.html" title="interface in org.apache.qpid.proton.engine">Record</a></td>
<td class="colLast">
<div class="block">Record</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/RecordAccessor.html" title="interface in org.apache.qpid.proton.engine">RecordAccessor</a>&lt;T&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.html" title="interface in org.apache.qpid.proton.engine">Sasl</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Sender.html" title="interface in org.apache.qpid.proton.engine">Sender</a></td>
<td class="colLast">
<div class="block">Sender</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Session.html" title="interface in org.apache.qpid.proton.engine">Session</a></td>
<td class="colLast">
<div class="block">Session
Note that session level flow control is handled internally by Proton.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Ssl.html" title="interface in org.apache.qpid.proton.engine">Ssl</a></td>
<td class="colLast">
<div class="block">I represent the details of a particular SSL session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/SslDomain.html" title="interface in org.apache.qpid.proton.engine">SslDomain</a></td>
<td class="colLast">
<div class="block">I store the details used to create SSL sessions.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/SslPeerDetails.html" title="interface in org.apache.qpid.proton.engine">SslPeerDetails</a></td>
<td class="colLast">
<div class="block">The details of the remote peer involved in an SSL session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Transport.html" title="interface in org.apache.qpid.proton.engine">Transport</a></td>
<td class="colLast">
<div class="block">
Operates on the entities in the associated <a href="../../../../../org/apache/qpid/proton/engine/Connection.html" title="interface in org.apache.qpid.proton.engine"><code>Connection</code></a>
by accepting and producing binary AMQP output, potentially
layered within SASL and/or SSL.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/TransportResult.html" title="interface in org.apache.qpid.proton.engine">TransportResult</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/BaseHandler.html" title="class in org.apache.qpid.proton.engine">BaseHandler</a></td>
<td class="colLast">
<div class="block">BaseHandler</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Collector.Factory.html" title="class in org.apache.qpid.proton.engine">Collector.Factory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Connection.Factory.html" title="class in org.apache.qpid.proton.engine">Connection.Factory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Engine.html" title="class in org.apache.qpid.proton.engine">Engine</a></td>
<td class="colLast">
<div class="block">Engine</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/ExtendableAccessor.html" title="class in org.apache.qpid.proton.engine">ExtendableAccessor</a>&lt;E extends <a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a>,T&gt;</td>
<td class="colLast">
<div class="block">A typesafe convenience class for associating additional data with <a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine"><code>Extendable</code></a> classes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/SslDomain.Factory.html" title="class in org.apache.qpid.proton.engine">SslDomain.Factory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/SslPeerDetails.Factory.html" title="class in org.apache.qpid.proton.engine">SslPeerDetails.Factory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Transport.Factory.html" title="class in org.apache.qpid.proton.engine">Transport.Factory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/TransportResultFactory.html" title="class in org.apache.qpid.proton.engine">TransportResultFactory</a></td>
<td class="colLast">
<div class="block">Creates TransportResults.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/EndpointState.html" title="enum in org.apache.qpid.proton.engine">EndpointState</a></td>
<td class="colLast">
<div class="block">Represents the state of a communication endpoint.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Event.Type.html" title="enum in org.apache.qpid.proton.engine">Event.Type</a></td>
<td class="colLast">
<div class="block">Event types built into the library.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslOutcome.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslOutcome</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/Sasl.SaslState.html" title="enum in org.apache.qpid.proton.engine">Sasl.SaslState</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/SslDomain.Mode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.Mode</a></td>
<td class="colLast">
<div class="block">Determines whether the endpoint acts as a client or server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/SslDomain.VerifyMode.html" title="enum in org.apache.qpid.proton.engine">SslDomain.VerifyMode</a></td>
<td class="colLast">
<div class="block">Determines the level of peer validation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/TransportResult.Status.html" title="enum in org.apache.qpid.proton.engine">TransportResult.Status</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/HandlerException.html" title="class in org.apache.qpid.proton.engine">HandlerException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/qpid/proton/engine/TransportException.html" title="class in org.apache.qpid.proton.engine">TransportException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</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">
<li><a href="../../../../../org/apache/qpid/proton/codec/transport/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/impl/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/engine/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>