blob: 39cb9c97e2abffd977023c5a82ce50ef30069a97 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Interface org.apache.qpid.protonj2.client.Tracker (Qpid ProtonJ2 Parent 1.0.0-M18 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="use: package: org.apache.qpid.protonj2.client, interface: Tracker">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript"></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><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Class</a></li>
<li class="nav-bar-cell1-rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../help-doc.html#use">Help</a></li>
</ul>
</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="Uses of Interface org.apache.qpid.protonj2.client.Tracker" class="title">Uses of Interface<br>org.apache.qpid.protonj2.client.Tracker</h1>
</div>
<div class="caption"><span>Packages that use <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></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="#org.apache.qpid.protonj2.client">org.apache.qpid.protonj2.client</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="#org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.qpid.protonj2.client">
<h2>Uses of <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a> in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> that return <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Tracker.</span><code><a href="../Tracker.html#awaitAccepted()" class="member-name-link">awaitAccepted</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Waits if necessary for the remote to settle the sent delivery with an <a href="../../types/messaging/Accepted.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Accepted</code></a>
disposition unless it has either already been settled and accepted or the original delivery
was sent settled in which case the remote will not send a <a href="../../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Disposition</code></a> back.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Tracker.</span><code><a href="../Tracker.html#awaitAccepted(long,java.util.concurrent.TimeUnit)" class="member-name-link">awaitAccepted</a><wbr>(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;unit)</code></div>
<div class="col-last odd-row-color">
<div class="block">Waits if necessary for the remote to settle the sent delivery with an <a href="../../types/messaging/Accepted.html" title="class in org.apache.qpid.protonj2.types.messaging"><code>Accepted</code></a>
disposition unless it has either already been settled and accepted or the original delivery
was sent settled in which case the remote will not send a <a href="../../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Disposition</code></a> back.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Tracker.</span><code><a href="../Tracker.html#awaitSettlement()" class="member-name-link">awaitSettlement</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Waits if necessary for the remote to settle the sent delivery unless it has
either already been settled or the original delivery was sent settled in which
case the remote will not send a <a href="../../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Disposition</code></a> back.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Tracker.</span><code><a href="../Tracker.html#awaitSettlement(long,java.util.concurrent.TimeUnit)" class="member-name-link">awaitSettlement</a><wbr>(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;unit)</code></div>
<div class="col-last odd-row-color">
<div class="block">Waits if necessary for the remote to settle the sent delivery unless it has
either already been settled or the original delivery was sent settled in which
case the remote will not send a <a href="../../types/transport/Disposition.html" title="class in org.apache.qpid.protonj2.types.transport"><code>Disposition</code></a> back.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Tracker.</span><code><a href="../Tracker.html#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)" class="member-name-link">disposition</a><wbr>(<a href="../DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;state,
boolean&nbsp;settle)</code></div>
<div class="col-last even-row-color">
<div class="block">Updates the DeliveryState, and optionally settle the delivery as well.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Connection.</span><code><a href="../Connection.html#send(org.apache.qpid.protonj2.client.Message)" class="member-name-link">send</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message)</code></div>
<div class="col-last odd-row-color">
<div class="block">Sends the given <a href="../Message.html" title="interface in org.apache.qpid.protonj2.client"><code>Message</code></a> using the internal connection sender.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Sender.</span><code><a href="../Sender.html#send(org.apache.qpid.protonj2.client.Message)" class="member-name-link">send</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message)</code></div>
<div class="col-last even-row-color">
<div class="block">Send the given message immediately if there is credit available or blocks if the link
has not yet been granted credit.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Sender.</span><code><a href="../Sender.html#send(org.apache.qpid.protonj2.client.Message,java.util.Map)" class="member-name-link">send</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</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>&gt;&nbsp;deliveryAnnotations)</code></div>
<div class="col-last odd-row-color">
<div class="block">Send the given message immediately if there is credit available or blocks if the link
has not yet been granted credit.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Tracker.</span><code><a href="../Tracker.html#settle()" class="member-name-link">settle</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Settles the delivery locally, if not <a href="../LinkOptions.html#autoSettle()"><code>auto-settling</code></a>.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Sender.</span><code><a href="../Sender.html#trySend(org.apache.qpid.protonj2.client.Message)" class="member-name-link">trySend</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message)</code></div>
<div class="col-last odd-row-color">
<div class="block">Send the given message if credit is available or returns null if no credit has been
granted to the link at the time of the send attempt.</div>
</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Sender.</span><code><a href="../Sender.html#trySend(org.apache.qpid.protonj2.client.Message,java.util.Map)" class="member-name-link">trySend</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</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>&gt;&nbsp;deliveryAnnotations)</code></div>
<div class="col-last even-row-color">
<div class="block">Send the given message if credit is available or returns null if no credit has been
granted to the link at the time of the send attempt.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.qpid.protonj2.client</a> that return types with arguments of type <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a>&lt;<a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Tracker.</span><code><a href="../Tracker.html#settlementFuture()" class="member-name-link">settlementFuture</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Returns a future that can be used to wait for the remote to acknowledge receipt of
a sent message by settling it.</div>
</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.qpid.protonj2.client.impl">
<h2>Uses of <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a> in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a></h2>
<div class="caption"><span>Classes in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> that implement <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></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">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../impl/ClientNoOpTracker.html" class="type-name-link" title="class in org.apache.qpid.protonj2.client.impl">ClientNoOpTracker</a></code></div>
<div class="col-last even-row-color">
<div class="block">A dummy Tracker instance that always indicates remote settlement and
acceptance.</div>
</div>
<div class="col-first odd-row-color"><code>final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../impl/ClientTracker.html" class="type-name-link" title="class in org.apache.qpid.protonj2.client.impl">ClientTracker</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Client outgoing delivery tracker object.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> that return <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientNoOpTracker.</span><code><a href="../impl/ClientNoOpTracker.html#awaitAccepted()" class="member-name-link">awaitAccepted</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientNoOpTracker.</span><code><a href="../impl/ClientNoOpTracker.html#awaitAccepted(long,java.util.concurrent.TimeUnit)" class="member-name-link">awaitAccepted</a><wbr>(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;unit)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientNoOpTracker.</span><code><a href="../impl/ClientNoOpTracker.html#awaitSettlement()" class="member-name-link">awaitSettlement</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientNoOpTracker.</span><code><a href="../impl/ClientNoOpTracker.html#awaitSettlement(long,java.util.concurrent.TimeUnit)" class="member-name-link">awaitSettlement</a><wbr>(long&nbsp;timeout,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a>&nbsp;unit)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientNoOpTracker.</span><code><a href="../impl/ClientNoOpTracker.html#disposition(org.apache.qpid.protonj2.client.DeliveryState,boolean)" class="member-name-link">disposition</a><wbr>(<a href="../DeliveryState.html" title="interface in org.apache.qpid.protonj2.client">DeliveryState</a>&nbsp;state,
boolean&nbsp;settle)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>protected <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientTracker.</span><code><a href="../impl/ClientTracker.html#self()" class="member-name-link">self</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientConnection.</span><code><a href="../impl/ClientConnection.html#send(org.apache.qpid.protonj2.client.Message)" class="member-name-link">send</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientSender.</span><code><a href="../impl/ClientSender.html#send(org.apache.qpid.protonj2.client.Message)" class="member-name-link">send</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientSender.</span><code><a href="../impl/ClientSender.html#send(org.apache.qpid.protonj2.client.Message,java.util.Map)" class="member-name-link">send</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</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>&gt;&nbsp;deliveryAnnotations)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientNoOpTracker.</span><code><a href="../impl/ClientNoOpTracker.html#settle()" class="member-name-link">settle</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientSender.</span><code><a href="../impl/ClientSender.html#trySend(org.apache.qpid.protonj2.client.Message)" class="member-name-link">trySend</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ClientSender.</span><code><a href="../impl/ClientSender.html#trySend(org.apache.qpid.protonj2.client.Message,java.util.Map)" class="member-name-link">trySend</a><wbr>(<a href="../Message.html" title="interface in org.apache.qpid.protonj2.client">Message</a>&lt;?&gt;&nbsp;message,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</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>&gt;&nbsp;deliveryAnnotations)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../impl/package-summary.html">org.apache.qpid.protonj2.client.impl</a> that return types with arguments of type <a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a>&lt;<a href="../Tracker.html" title="interface in org.apache.qpid.protonj2.client">Tracker</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ClientNoOpTracker.</span><code><a href="../impl/ClientNoOpTracker.html#settlementFuture()" class="member-name-link">settlementFuture</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>