Google Git
Sign in
apache / activemq-website / 2f0ea037071f351fec535cb12debcfd4ca872533 / . / src / components / artemis / documentation / javadocs / javadoc-latest / org / apache / activemq / artemis / core / client / impl / ClientConsumerImpl.html
blob: 8e550c5914b1d0f47246563daacbf4ab4f8e085d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ClientConsumerImpl (ActiveMQ Artemis Website 2.29.0 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="ClientConsumerImpl (ActiveMQ Artemis Website 2.29.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClientConsumerImpl.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&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.activemq.artemis.core.client.impl</a></div>
<h2 title="Class ClientConsumerImpl" class="title">Class ClientConsumerImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.activemq.artemis.core.client.impl.ClientConsumerImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code>, <code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code>, <code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
<hr>
<pre>public final class <span class="typeNameLabel">ClientConsumerImpl</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FORCED_DELIVERY_MESSAGE">FORCED_DELIVERY_MESSAGE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.activemq.artemis.core.client.impl.ClientSessionInternal,org.apache.activemq.artemis.spi.core.remoting.ConsumerContext,org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.SimpleString,int,boolean,int,int,int,org.apache.activemq.artemis.utils.TokenBucketLimiter,java.util.concurrent.Executor,java.util.concurrent.Executor,org.apache.activemq.artemis.spi.core.remoting.SessionContext,org.apache.activemq.artemis.api.core.client.ClientSession.QueueQuery,java.lang.ClassLoader)">ClientConsumerImpl</a></span>&#8203;(<a href="ClientSessionInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientSessionInternal</a>&nbsp;session,
<a href="../../../spi/core/remoting/ConsumerContext.html" title="class in org.apache.activemq.artemis.spi.core.remoting">ConsumerContext</a>&nbsp;consumerContext,
<a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a>&nbsp;queueName,
<a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a>&nbsp;filterString,
int&nbsp;priority,
boolean&nbsp;browseOnly,
int&nbsp;initialWindow,
int&nbsp;clientWindowSize,
int&nbsp;ackBatchSize,
org.apache.activemq.artemis.utils.TokenBucketLimiter&nbsp;rateLimiter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Executor</a>&nbsp;executor,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Executor</a>&nbsp;flowControlExecutor,
<a href="../../../spi/core/remoting/SessionContext.html" title="class in org.apache.activemq.artemis.spi.core.remoting">SessionContext</a>&nbsp;sessionContext,
<a href="../../../api/core/client/ClientSession.QueueQuery.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession.QueueQuery</a>&nbsp;queueInfo,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a>&nbsp;contextClassLoader)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acknowledge(org.apache.activemq.artemis.api.core.client.ClientMessage)">acknowledge</a></span>&#8203;(<a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a>&nbsp;message)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cleanUp()">cleanUp</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear(boolean)">clear</a></span>&#8203;(boolean&nbsp;waitForOnMessage)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearAtFailover()">clearAtFailover</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Closes the consumer.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flowControl(int,boolean)">flowControl</a></span>&#8203;(int&nbsp;messageBytes,
boolean&nbsp;discountSlowConsumer)</code></th>
<td class="colLast">
<div class="block">LargeMessageBuffer will call flowcontrol here, while other handleMessage will also be calling flowControl.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flushAcks()">flushAcks</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBufferSize()">getBufferSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getClientWindowSize()">getClientWindowSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../spi/core/remoting/ConsumerContext.html" title="class in org.apache.activemq.artemis.spi.core.remoting">ConsumerContext</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConsumerContext()">getConsumerContext</a></span>()</code></th>
<td class="colLast">
<div class="block">The server's ID associated with this consumer.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang" class="externalLink">Thread</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentThread()">getCurrentThread</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFilterString()">getFilterString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getForceDeliveryCount()">getForceDeliveryCount</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitialWindowSize()">getInitialWindowSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLastException()">getLastException</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the last exception thrown by a call to this consumer's MessageHandler.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../api/core/client/MessageHandler.html" title="interface in org.apache.activemq.artemis.api.core.client">MessageHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageHandler()">getMessageHandler</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the MessageHandler associated to this consumer.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPriority()">getPriority</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../api/core/client/ClientSession.QueueQuery.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession.QueueQuery</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueueInfo()">getQueueInfo</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueueName()">getQueueName</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleLargeMessage(org.apache.activemq.artemis.core.client.impl.ClientLargeMessageInternal,long)">handleLargeMessage</a></span>&#8203;(<a href="ClientLargeMessageInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientLargeMessageInternal</a>&nbsp;clientLargeMessage,
long&nbsp;largeMessageSize)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleLargeMessageContinuation(byte%5B%5D,int,boolean)">handleLargeMessageContinuation</a></span>&#8203;(byte[]&nbsp;chunk,
int&nbsp;flowControlSize,
boolean&nbsp;isContinues)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#handleMessage(org.apache.activemq.artemis.core.client.impl.ClientMessageInternal)">handleMessage</a></span>&#8203;(<a href="ClientMessageInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientMessageInternal</a>&nbsp;message)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#individualAcknowledge(org.apache.activemq.artemis.api.core.client.ClientMessage)">individualAcknowledge</a></span>&#8203;(<a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a>&nbsp;message)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBrowseOnly()">isBrowseOnly</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isClosed()">isClosed</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the consumer is closed or not.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang" class="externalLink">Thread</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareForClose(org.apache.activemq.artemis.utils.FutureLatch)">prepareForClose</a></span>&#8203;(org.apache.activemq.artemis.utils.FutureLatch&nbsp;future)</code></th>
<td class="colLast">
<div class="block">To be used by MDBs to stop any more handling of messages.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receive()">receive</a></span>()</code></th>
<td class="colLast">
<div class="block">Receives a message from a queue.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receive(long)">receive</a></span>&#8203;(long&nbsp;timeout)</code></th>
<td class="colLast">
<div class="block">Receives a message from a queue.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#receiveImmediate()">receiveImmediate</a></span>()</code></th>
<td class="colLast">
<div class="block">Receives a message from a queue.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="ClientConsumerImpl.html" title="class in org.apache.activemq.artemis.core.client.impl">ClientConsumerImpl</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageHandler(org.apache.activemq.artemis.api.core.client.MessageHandler)">setMessageHandler</a></span>&#8203;(<a href="../../../api/core/client/MessageHandler.html" title="interface in org.apache.activemq.artemis.api.core.client">MessageHandler</a>&nbsp;theHandler)</code></th>
<td class="colLast">
<div class="block">Sets the MessageHandler for this consumer to consume messages asynchronously.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#stop(boolean)">stop</a></span>&#8203;(boolean&nbsp;waitForOnMessage)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="FORCED_DELIVERY_MESSAGE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FORCED_DELIVERY_MESSAGE</h4>
<pre>public static final&nbsp;<a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a> FORCED_DELIVERY_MESSAGE</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.activemq.artemis.core.client.impl.ClientSessionInternal,org.apache.activemq.artemis.spi.core.remoting.ConsumerContext,org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.SimpleString,int,boolean,int,int,int,org.apache.activemq.artemis.utils.TokenBucketLimiter,java.util.concurrent.Executor,java.util.concurrent.Executor,org.apache.activemq.artemis.spi.core.remoting.SessionContext,org.apache.activemq.artemis.api.core.client.ClientSession.QueueQuery,java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ClientConsumerImpl</h4>
<pre>public&nbsp;ClientConsumerImpl&#8203;(<a href="ClientSessionInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientSessionInternal</a>&nbsp;session,
<a href="../../../spi/core/remoting/ConsumerContext.html" title="class in org.apache.activemq.artemis.spi.core.remoting">ConsumerContext</a>&nbsp;consumerContext,
<a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a>&nbsp;queueName,
<a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a>&nbsp;filterString,
int&nbsp;priority,
boolean&nbsp;browseOnly,
int&nbsp;initialWindow,
int&nbsp;clientWindowSize,
int&nbsp;ackBatchSize,
org.apache.activemq.artemis.utils.TokenBucketLimiter&nbsp;rateLimiter,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Executor</a>&nbsp;executor,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Executor.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Executor</a>&nbsp;flowControlExecutor,
<a href="../../../spi/core/remoting/SessionContext.html" title="class in org.apache.activemq.artemis.spi.core.remoting">SessionContext</a>&nbsp;sessionContext,
<a href="../../../api/core/client/ClientSession.QueueQuery.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession.QueueQuery</a>&nbsp;queueInfo,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a>&nbsp;contextClassLoader)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getConsumerContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConsumerContext</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../spi/core/remoting/ConsumerContext.html" title="class in org.apache.activemq.artemis.spi.core.remoting">ConsumerContext</a>&nbsp;getConsumerContext()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html#getConsumerContext()">ClientConsumer</a></code></span></div>
<div class="block">The server's ID associated with this consumer.
ActiveMQ Artemis implements this as a long but this could be protocol dependent.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientConsumer.html#getConsumerContext()">getConsumerContext</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a id="receive(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receive</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a>&nbsp;receive&#8203;(long&nbsp;timeout)
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html#receive(long)">ClientConsumer</a></code></span></div>
<div class="block">Receives a message from a queue.
<p>
This call will block until a message is received or the given timeout expires.
<p>
Calling this method on a closed consumer will throw an ActiveMQException.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientConsumer.html#receive(long)">receive</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - time (in milliseconds) to wait to receive a message</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message or <code>null</code> if the time out expired</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code> - if an exception occurs while waiting to receive a message</dd>
</dl>
</li>
</ul>
<a id="receive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receive</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a>&nbsp;receive()
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html#receive()">ClientConsumer</a></code></span></div>
<div class="block">Receives a message from a queue.
<p>
This call will block indefinitely until a message is received.
<p>
Calling this method on a closed consumer will throw an ActiveMQException.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientConsumer.html#receive()">receive</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a ClientMessage</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code> - if an exception occurs while waiting to receive a message</dd>
</dl>
</li>
</ul>
<a id="receiveImmediate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receiveImmediate</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a>&nbsp;receiveImmediate()
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html#receiveImmediate()">ClientConsumer</a></code></span></div>
<div class="block">Receives a message from a queue. This call will force a network trip to ActiveMQ Artemis server to
ensure that there are no messages in the queue which can be delivered to this consumer.
<p>
This call will never wait indefinitely for a message, it will return <code>null</code> if no
messages are available for this consumer.
<p>
Note however that there is a performance cost as an additional network trip to the server may
required to check the queue status.
<p>
Calling this method on a closed consumer will throw an ActiveMQException.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientConsumer.html#receiveImmediate()">receiveImmediate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message or <code>null</code> if there are no messages in the queue for this consumer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code> - if an exception occurs while waiting to receive a message</dd>
</dl>
</li>
</ul>
<a id="getMessageHandler()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../api/core/client/MessageHandler.html" title="interface in org.apache.activemq.artemis.api.core.client">MessageHandler</a>&nbsp;getMessageHandler()
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html#getMessageHandler()">ClientConsumer</a></code></span></div>
<div class="block">Returns the MessageHandler associated to this consumer.
<p>
Calling this method on a closed consumer will throw an ActiveMQException.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientConsumer.html#getMessageHandler()">getMessageHandler</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the MessageHandler associated to this consumer or <code>null</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code> - if an exception occurs while getting the MessageHandler</dd>
</dl>
</li>
</ul>
<a id="getCurrentThread()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentThread</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang" class="externalLink">Thread</a>&nbsp;getCurrentThread()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#getCurrentThread()">getCurrentThread</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="setMessageHandler(org.apache.activemq.artemis.api.core.client.MessageHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="ClientConsumerImpl.html" title="class in org.apache.activemq.artemis.core.client.impl">ClientConsumerImpl</a>&nbsp;setMessageHandler&#8203;(<a href="../../../api/core/client/MessageHandler.html" title="interface in org.apache.activemq.artemis.api.core.client">MessageHandler</a>&nbsp;theHandler)
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html#setMessageHandler(org.apache.activemq.artemis.api.core.client.MessageHandler)">ClientConsumer</a></code></span></div>
<div class="block">Sets the MessageHandler for this consumer to consume messages asynchronously.
<p>
Note that setting a handler dedicates the parent session, and its child producers
and consumers, to the session-wide handler delivery thread of control.
<p>
Calling this method on a closed consumer will throw a ActiveMQException.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientConsumer.html#setMessageHandler(org.apache.activemq.artemis.api.core.client.MessageHandler)">setMessageHandler</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theHandler</code> - a MessageHandler</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code> - if an exception occurs while setting the MessageHandler</dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html#close()">ClientConsumer</a></code></span></div>
<div class="block">Closes the consumer.
<p>
Once this consumer is closed, it can not receive messages, whether synchronously or
asynchronously.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang" class="externalLink">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientConsumer.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code></dd>
</dl>
</li>
</ul>
<a id="prepareForClose(org.apache.activemq.artemis.utils.FutureLatch)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareForClose</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Thread.html?is-external=true" title="class or interface in java.lang" class="externalLink">Thread</a>&nbsp;prepareForClose&#8203;(org.apache.activemq.artemis.utils.FutureLatch&nbsp;future)
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<div class="block">To be used by MDBs to stop any more handling of messages.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#prepareForClose(org.apache.activemq.artemis.utils.FutureLatch)">prepareForClose</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>future</code> - the future to run once the onMessage Thread has completed</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code></dd>
</dl>
</li>
</ul>
<a id="cleanUp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanUp</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;cleanUp()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#cleanUp()">cleanUp</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="isClosed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isClosed()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html#isClosed()">ClientConsumer</a></code></span></div>
<div class="block">Returns whether the consumer is closed or not.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientConsumer.html#isClosed()">isClosed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if this consumer is closed, <code>false</code> else</dd>
</dl>
</li>
</ul>
<a id="stop(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;stop&#8203;(boolean&nbsp;waitForOnMessage)
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#stop(boolean)">stop</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code></dd>
</dl>
</li>
</ul>
<a id="clearAtFailover()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearAtFailover</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clearAtFailover()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#clearAtFailover()">clearAtFailover</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="start()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;start()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#start()">start</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="getLastException()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLastException</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a>&nbsp;getLastException()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html#getLastException()">ClientConsumer</a></code></span></div>
<div class="block">Returns the last exception thrown by a call to this consumer's MessageHandler.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientConsumer.html#getLastException()">getLastException</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientConsumer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientConsumer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the last exception thrown by a call to this consumer's MessageHandler or <code>null</code></dd>
</dl>
</li>
</ul>
<a id="getQueueInfo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueInfo</h4>
<pre class="methodSignature">public&nbsp;<a href="../../../api/core/client/ClientSession.QueueQuery.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession.QueueQuery</a>&nbsp;getQueueInfo()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#getQueueInfo()">getQueueInfo</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="getForceDeliveryCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForceDeliveryCount</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getForceDeliveryCount()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#getForceDeliveryCount()">getForceDeliveryCount</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="getFilterString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a>&nbsp;getFilterString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#getFilterString()">getFilterString</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="getPriority()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPriority</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getPriority()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#getPriority()">getPriority</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="getQueueName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueName</h4>
<pre class="methodSignature">public&nbsp;<a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/SimpleString.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">SimpleString</a>&nbsp;getQueueName()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#getQueueName()">getQueueName</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="isBrowseOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBrowseOnly</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isBrowseOnly()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#isBrowseOnly()">isBrowseOnly</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="handleMessage(org.apache.activemq.artemis.core.client.impl.ClientMessageInternal)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleMessage</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleMessage&#8203;(<a href="ClientMessageInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientMessageInternal</a>&nbsp;message)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#handleMessage(org.apache.activemq.artemis.core.client.impl.ClientMessageInternal)">handleMessage</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="handleLargeMessage(org.apache.activemq.artemis.core.client.impl.ClientLargeMessageInternal,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleLargeMessage</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleLargeMessage&#8203;(<a href="ClientLargeMessageInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientLargeMessageInternal</a>&nbsp;clientLargeMessage,
long&nbsp;largeMessageSize)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#handleLargeMessage(org.apache.activemq.artemis.core.client.impl.ClientLargeMessageInternal,long)">handleLargeMessage</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="handleLargeMessageContinuation(byte[],int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>handleLargeMessageContinuation</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;handleLargeMessageContinuation&#8203;(byte[]&nbsp;chunk,
int&nbsp;flowControlSize,
boolean&nbsp;isContinues)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#handleLargeMessageContinuation(byte%5B%5D,int,boolean)">handleLargeMessageContinuation</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd>
</dl>
</li>
</ul>
<a id="clear(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clear&#8203;(boolean&nbsp;waitForOnMessage)
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#clear(boolean)">clear</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code></dd>
</dl>
</li>
</ul>
<a id="getInitialWindowSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialWindowSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getInitialWindowSize()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#getInitialWindowSize()">getInitialWindowSize</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="getClientWindowSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientWindowSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getClientWindowSize()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#getClientWindowSize()">getClientWindowSize</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="getBufferSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getBufferSize()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#getBufferSize()">getBufferSize</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="acknowledge(org.apache.activemq.artemis.api.core.client.ClientMessage)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acknowledge</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;acknowledge&#8203;(<a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a>&nbsp;message)
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#acknowledge(org.apache.activemq.artemis.api.core.client.ClientMessage)">acknowledge</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code></dd>
</dl>
</li>
</ul>
<a id="individualAcknowledge(org.apache.activemq.artemis.api.core.client.ClientMessage)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>individualAcknowledge</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;individualAcknowledge&#8203;(<a href="../../../api/core/client/ClientMessage.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientMessage</a>&nbsp;message)
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#individualAcknowledge(org.apache.activemq.artemis.api.core.client.ClientMessage)">individualAcknowledge</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code></dd>
</dl>
</li>
</ul>
<a id="flushAcks()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flushAcks</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;flushAcks()
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#flushAcks()">flushAcks</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code></dd>
</dl>
</li>
</ul>
<a id="flowControl(int,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flowControl</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;flowControl&#8203;(int&nbsp;messageBytes,
boolean&nbsp;discountSlowConsumer)
throws <a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></pre>
<div class="block">LargeMessageBuffer will call flowcontrol here, while other handleMessage will also be calling flowControl.
So, this operation needs to be atomic.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientConsumerInternal.html#flowControl(int,boolean)">flowControl</a></code>&nbsp;in interface&nbsp;<code><a href="ClientConsumerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientConsumerInternal</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>discountSlowConsumer</code> - When dealing with slowConsumers, we need to discount one credit that was pre-sent when the first receive was called. For largeMessage that is only done at the latest packet</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://activemq.apache.org/components/artemis/artemis-core-client/apidocs/org/apache/activemq/artemis/api/core/ActiveMQException.html?is-external=true" title="class or interface in org.apache.activemq.artemis.api.core" class="externalLink">ActiveMQException</a></code></dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClientConsumerImpl.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&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>