blob: 9b016d71be7754aee9a5e71cd9ab7ed70a721dbe [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.qpid.protonj2.client (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.client">
<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:&nbsp;</li>
<li>Description&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</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.client" class="title">Package org.apache.qpid.protonj2.client</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.qpid.protonj2.client</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.client.exceptions</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="futures/package-summary.html">org.apache.qpid.protonj2.client.futures</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="transport/package-summary.html">org.apache.qpid.protonj2.client.transport</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="util/package-summary.html">org.apache.qpid.protonj2.client.util</a></div>
<div class="col-last even-row-color">&nbsp;</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-tab1"><a href="AdvancedMessage.html" title="interface in org.apache.qpid.protonj2.client">AdvancedMessage</a>&lt;E&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Advanced AMQP Message object that provides a thin abstraction to raw AMQP types</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">The Container that hosts AMQP Connections.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ClientOptions.html" title="class in org.apache.qpid.protonj2.client">ClientOptions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Container Options for customizing the behavior of the Container</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Top level <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> object that can be used as a stand alone API for sending
messages and creating <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instances for message consumption.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ConnectionEvent.html" title="class in org.apache.qpid.protonj2.client">ConnectionEvent</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An event object that accompanies events fired to handlers configured in the
<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> which are signaled during specific <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
event points.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client">ConnectionOptions</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Options that control the behavior of the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> created from them.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Delivery.html" title="interface in org.apache.qpid.protonj2.client">Delivery</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Incoming Delivery type that provides access to the message and the delivery
data along with methods for settling the delivery when processing completes.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="DeliveryMode.html" title="enum in org.apache.qpid.protonj2.client">DeliveryMode</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Control the message delivery guarantee for senders and receivers</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Conveys the outcome of a Delivery either incoming or outgoing.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="DeliveryState.Type.html" title="enum in org.apache.qpid.protonj2.client">DeliveryState.Type</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DisconnectionEvent.html" title="class in org.apache.qpid.protonj2.client">DisconnectionEvent</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An event object that accompanies events fired to handlers configured in the
<a href="ConnectionOptions.html" title="class in org.apache.qpid.protonj2.client"><code>ConnectionOptions</code></a> which are signaled during specific <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>
life-cycle stages.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="DistributionMode.html" title="enum in org.apache.qpid.protonj2.client">DistributionMode</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Control whether messages are browsed or consumed.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="DurabilityMode.html" title="enum in org.apache.qpid.protonj2.client">DurabilityMode</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">Control the persistence of source or target state.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Conveys the error value used to inform the user of why an endpoint
was closed or a delivery rejected.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="ExpiryPolicy.html" title="enum in org.apache.qpid.protonj2.client">ExpiryPolicy</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">Control when the clock for expiration begins.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Link.html" title="interface in org.apache.qpid.protonj2.client">Link</a>&lt;T extends <a href="Link.html" title="interface in org.apache.qpid.protonj2.client">Link</a>&lt;T&gt;&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Base for all AMQP link types (Sender, Receiver etc).</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LinkOptions.html" title="class in org.apache.qpid.protonj2.client">LinkOptions</a>&lt;T extends <a href="LinkOptions.html" title="class in org.apache.qpid.protonj2.client">LinkOptions</a>&lt;T&gt;&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Base options that are applied to AMQP link types.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;E&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Message object that provides a high level abstraction to raw AMQP types</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="NextReceiverPolicy.html" title="enum in org.apache.qpid.protonj2.client">NextReceiverPolicy</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">Determines the behavior of a Session when the next receiver method is called
on that session.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="OutputStreamOptions.html" title="class in org.apache.qpid.protonj2.client">OutputStreamOptions</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Options class that controls various aspects of a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link"><code>OutputStream</code></a> instance created to write
the contents of a section of a <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a>.</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.client">Receiver</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">AMQP Receiver that provides an interface to receive complete Deliveries from a remote
peer.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">ReceiverOptions</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Options that control the behavior of the <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> created from them.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ReconnectLocation.html" title="class in org.apache.qpid.protonj2.client">ReconnectLocation</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Represents a reconnection host used to track location and configuration
for individual remote hosts that can be used to re-establish a connection
on loss of connectivity.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ReconnectOptions.html" title="class in org.apache.qpid.protonj2.client">ReconnectOptions</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Options that control the reconnection behavior of a client <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SaslOptions.html" title="class in org.apache.qpid.protonj2.client">SaslOptions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Connection options that are applied to the SASL layer.</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.client">Sender</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">AMQP Sender that provides an API for sending complete Message payload data.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SenderOptions.html" title="class in org.apache.qpid.protonj2.client">SenderOptions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Options that control the behavior of a <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> created from them.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Session object used to create <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> and <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> instances.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SessionOptions.html" title="class in org.apache.qpid.protonj2.client">SessionOptions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Options that control the behavior of the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> created from them.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Source.html" title="interface in org.apache.qpid.protonj2.client">Source</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">The Source for messages.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SourceOptions.html" title="class in org.apache.qpid.protonj2.client">SourceOptions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Options type that carries configuration for link Source types.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SslOptions.html" title="class in org.apache.qpid.protonj2.client">SslOptions</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Options for configuration of the client SSL layer</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client">StreamDelivery</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A specialized <a href="StreamDelivery.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamDelivery</code></a> type that is returned from the <a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a>
which can be used to read incoming large messages that are streamed via multiple incoming
AMQP <a href="../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frames.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A receiver of large message content that is delivered in multiple <a href="../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frames from
the remote.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="StreamReceiverMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiverMessage</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A specialized <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> type that represents a streamed delivery possibly
spanning many incoming <a href="../types/transport/Transfer.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Transfer</code></a> frames from the remote peer.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StreamReceiverOptions.html" title="class in org.apache.qpid.protonj2.client">StreamReceiverOptions</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Options class that controls various aspects of a <a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamReceiver</code></a> instance and how
a streamed message transfer is written.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Sending link implementation that allows sending of large message payload data in
multiple transfers to reduce memory overhead of large message sends.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client">StreamSenderMessage</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Streaming Message Tracker object used to operate on and track the state of a streamed message
at the remote.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="StreamSenderOptions.html" title="class in org.apache.qpid.protonj2.client">StreamSenderOptions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Options class that controls various aspects of a <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a> instance and how
a streamed message transfer is written.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StreamTracker.html" title="interface in org.apache.qpid.protonj2.client">StreamTracker</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Special StreamSender related <a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client"><code>Tracker</code></a> that is linked to any <a href="StreamSenderMessage.html" title="interface in org.apache.qpid.protonj2.client"><code>StreamSenderMessage</code></a>
instance and provides the <a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client"><code>Tracker</code></a> functions for those types of messages.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Target.html" title="interface in org.apache.qpid.protonj2.client">Target</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">The Target of messages.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TargetOptions.html" title="class in org.apache.qpid.protonj2.client">TargetOptions</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Options type that carries configuration for link Target types.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TerminusOptions.html" title="class in org.apache.qpid.protonj2.client">TerminusOptions</a>&lt;E extends <a href="TerminusOptions.html" title="class in org.apache.qpid.protonj2.client">TerminusOptions</a>&lt;E&gt;&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Base options type for configuration of <a href="../types/messaging/Source.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Source</code></a> and <a href="../types/messaging/Target.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Target</code></a> types
used by <a href="Sender.html" title="interface in org.apache.qpid.protonj2.client"><code>Sender</code></a> and <a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client"><code>Receiver</code></a> end points.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Tracker object used to track the state of a sent <a href="Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> at the remote
and allows for local settlement and disposition management.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TransportOptions.html" title="class in org.apache.qpid.protonj2.client">TransportOptions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Encapsulates all the Transport options in one configuration object.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>