Google Git
Sign in
apache / activemq-website / 2f0ea037071f351fec535cb12debcfd4ca872533 / . / src / components / artemis / documentation / javadocs / javadoc-latest / org / apache / activemq / artemis / core / server / ServerConsumer.html
blob: 3f6652eda822b3c02da686f9164a753999213b9d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ServerConsumer (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="ServerConsumer (ActiveMQ Artemis Website 2.29.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ServerConsumer.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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.server</a></div>
<h2 title="Interface ServerConsumer" class="title">Interface ServerConsumer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="Consumer.html" title="interface in org.apache.activemq.artemis.core.server">Consumer</a></code>, <code><a href="ConsumerInfo.html" title="interface in org.apache.activemq.artemis.core.server">ConsumerInfo</a></code>, <code>org.apache.activemq.artemis.core.PriorityAware</code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="impl/ServerConsumerImpl.html" title="class in org.apache.activemq.artemis.core.server.impl">ServerConsumerImpl</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ServerConsumer</span>
extends <a href="Consumer.html" title="interface in org.apache.activemq.artemis.core.server">Consumer</a>, <a href="ConsumerInfo.html" title="interface in org.apache.activemq.artemis.core.server">ConsumerInfo</a></pre>
<div class="block">A ServerConsumer</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acknowledge(org.apache.activemq.artemis.core.transaction.Transaction,long)">acknowledge</a></span>&#8203;(<a href="../transaction/Transaction.html" title="interface in org.apache.activemq.artemis.core.transaction">Transaction</a>&nbsp;tx,
long&nbsp;messageID)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowReferenceCallback()">allowReferenceCallback</a></span>()</code></th>
<td class="colLast">
<div class="block">the current queue settings will allow use of the Reference Execution and callback.</div>
</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="#backToDelivering(org.apache.activemq.artemis.core.server.MessageReference)">backToDelivering</a></span>&#8203;(<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>&nbsp;reference)</code></th>
<td class="colLast">
<div class="block">Some protocols may choose to send the message back to delivering instead of redeliver.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancelRefs(boolean,boolean,org.apache.activemq.artemis.core.transaction.Transaction)">cancelRefs</a></span>&#8203;(boolean&nbsp;failed,
boolean&nbsp;lastConsumedAsDelivered,
<a href="../transaction/Transaction.html" title="interface in org.apache.activemq.artemis.core.transaction">Transaction</a>&nbsp;tx)</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(boolean)">close</a></span>&#8203;(boolean&nbsp;failed)</code></th>
<td class="colLast">&nbsp;</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="#fireSlowConsumer()">fireSlowConsumer</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#forceDelivery(long)">forceDelivery</a></span>&#8203;(long&nbsp;sequence)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><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></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConnectionID()">getConnectionID</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCreationTime()">getCreationTime</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getID()">getID</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><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></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocolContext()">getProtocolContext</a></span>()</code></th>
<td class="colLast">
<div class="block">An object set by the Protocol implementation.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><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></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocolData()">getProtocolData</a></span>()</code></th>
<td class="colLast">
<div class="block">this is to be used with anything specific on a protocol head.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="Queue.html" title="interface in org.apache.activemq.artemis.core.server">Queue</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueue()">getQueue</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<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="#getSessionID()">getSessionID</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="SlowConsumerDetectionListener.html" title="interface in org.apache.activemq.artemis.core.server">SlowConsumerDetectionListener</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSlowConsumerDetecion()">getSlowConsumerDetecion</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#individualAcknowledge(org.apache.activemq.artemis.core.transaction.Transaction,long)">individualAcknowledge</a></span>&#8203;(<a href="../transaction/Transaction.html" title="interface in org.apache.activemq.artemis.core.transaction">Transaction</a>&nbsp;tx,
long&nbsp;messageID)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#individualCancel(long,boolean)">individualCancel</a></span>&#8203;(long&nbsp;messageID,
boolean&nbsp;failed)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" 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="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#metricsAcknowledge(org.apache.activemq.artemis.core.server.MessageReference,org.apache.activemq.artemis.core.transaction.Transaction)">metricsAcknowledge</a></span>&#8203;(<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>&nbsp;ref,
<a href="../transaction/Transaction.html" title="interface in org.apache.activemq.artemis.core.transaction">Transaction</a>&nbsp;transaction)</code></th>
<td class="colLast">
<div class="block">This is needed when some protocols (OW) handle the acks themselves and need to update the metrics</div>
</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="#receiveCredits(int)">receiveCredits</a></span>&#8203;(int&nbsp;credits)</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="#reject(long)">reject</a></span>&#8203;(long&nbsp;messageID)</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="#removeItself()">removeItself</a></span>()</code></th>
<td class="colLast">
<div class="block">This method is just to remove itself from Queues.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeReferenceByID(long)">removeReferenceByID</a></span>&#8203;(long&nbsp;messageID)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scanDeliveringReferences(boolean,java.util.function.Function,java.util.function.Function)">scanDeliveringReferences</a></span>&#8203;(boolean&nbsp;remove,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a>&lt;<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a>&gt;&nbsp;startFunction,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a>&lt;<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a>&gt;&nbsp;endFunction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setlowConsumerDetection(org.apache.activemq.artemis.core.server.SlowConsumerDetectionListener)">setlowConsumerDetection</a></span>&#8203;(<a href="SlowConsumerDetectionListener.html" title="interface in org.apache.activemq.artemis.core.server">SlowConsumerDetectionListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProtocolContext(java.lang.Object)">setProtocolContext</a></span>&#8203;(<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>&nbsp;protocolContext)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setProtocolData(java.lang.Object)">setProtocolData</a></span>&#8203;(<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>&nbsp;protocolData)</code></th>
<td class="colLast">
<div class="block">this is to be used with anything specific on a protocol head.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStarted(boolean)">setStarted</a></span>&#8203;(boolean&nbsp;started)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransferring(boolean)">setTransferring</a></span>&#8203;(boolean&nbsp;transferring)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.activemq.artemis.core.server.Consumer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.activemq.artemis.core.server.<a href="Consumer.html" title="interface in org.apache.activemq.artemis.core.server">Consumer</a></h3>
<code><a href="Consumer.html#debug()">debug</a>, <a href="Consumer.html#disconnect()">disconnect</a>, <a href="Consumer.html#errorProcessing(java.lang.Throwable,org.apache.activemq.artemis.core.server.MessageReference)">errorProcessing</a>, <a href="Consumer.html#failed(java.lang.Throwable)">failed</a>, <a href="Consumer.html#getBinding()">getBinding</a>, <a href="Consumer.html#getDeliveringMessages()">getDeliveringMessages</a>, <a href="Consumer.html#getFilter()">getFilter</a>, <a href="Consumer.html#getPriority()">getPriority</a>, <a href="Consumer.html#handle(org.apache.activemq.artemis.core.server.MessageReference)">handle</a>, <a href="Consumer.html#isClosed()">isClosed</a>, <a href="Consumer.html#proceedDeliver(org.apache.activemq.artemis.core.server.MessageReference)">proceedDeliver</a>, <a href="Consumer.html#promptDelivery()">promptDelivery</a>, <a href="Consumer.html#sequentialID()">sequentialID</a>, <a href="Consumer.html#supportsDirectDelivery()">supportsDirectDelivery</a>, <a href="Consumer.html#toManagementString()">toManagementString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.activemq.artemis.core.server.ConsumerInfo">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.activemq.artemis.core.server.<a href="ConsumerInfo.html" title="interface in org.apache.activemq.artemis.core.server">ConsumerInfo</a></h3>
<code><a href="ConsumerInfo.html#getConnectionClientID()">getConnectionClientID</a>, <a href="ConsumerInfo.html#getConnectionLocalAddress()">getConnectionLocalAddress</a>, <a href="ConsumerInfo.html#getConnectionProtocolName()">getConnectionProtocolName</a>, <a href="ConsumerInfo.html#getConnectionRemoteAddress()">getConnectionRemoteAddress</a>, <a href="ConsumerInfo.html#getFilterString()">getFilterString</a>, <a href="ConsumerInfo.html#getLastAcknowledgedTime()">getLastAcknowledgedTime</a>, <a href="ConsumerInfo.html#getLastDeliveredTime()">getLastDeliveredTime</a>, <a href="ConsumerInfo.html#getMessagesAcknowledged()">getMessagesAcknowledged</a>, <a href="ConsumerInfo.html#getMessagesAcknowledgedAwaitingCommit()">getMessagesAcknowledgedAwaitingCommit</a>, <a href="ConsumerInfo.html#getMessagesDelivered()">getMessagesDelivered</a>, <a href="ConsumerInfo.html#getMessagesDeliveredSize()">getMessagesDeliveredSize</a>, <a href="ConsumerInfo.html#getMessagesInTransit()">getMessagesInTransit</a>, <a href="ConsumerInfo.html#getMessagesInTransitSize()">getMessagesInTransitSize</a>, <a href="ConsumerInfo.html#getQueueAddress()">getQueueAddress</a>, <a href="ConsumerInfo.html#getQueueName()">getQueueName</a>, <a href="ConsumerInfo.html#getQueueType()">getQueueType</a>, <a href="ConsumerInfo.html#getSequentialID()">getSequentialID</a>, <a href="ConsumerInfo.html#getSessionName()">getSessionName</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setlowConsumerDetection(org.apache.activemq.artemis.core.server.SlowConsumerDetectionListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setlowConsumerDetection</h4>
<pre class="methodSignature">void&nbsp;setlowConsumerDetection&#8203;(<a href="SlowConsumerDetectionListener.html" title="interface in org.apache.activemq.artemis.core.server">SlowConsumerDetectionListener</a>&nbsp;listener)</pre>
</li>
</ul>
<a id="getSlowConsumerDetecion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSlowConsumerDetecion</h4>
<pre class="methodSignature"><a href="SlowConsumerDetectionListener.html" title="interface in org.apache.activemq.artemis.core.server">SlowConsumerDetectionListener</a>&nbsp;getSlowConsumerDetecion()</pre>
</li>
</ul>
<a id="fireSlowConsumer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fireSlowConsumer</h4>
<pre class="methodSignature">void&nbsp;fireSlowConsumer()</pre>
</li>
</ul>
<a id="allowReferenceCallback()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowReferenceCallback</h4>
<pre class="methodSignature">boolean&nbsp;allowReferenceCallback()</pre>
<div class="block">the current queue settings will allow use of the Reference Execution and callback.
This is because</div>
</li>
</ul>
<a id="getProtocolData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocolData</h4>
<pre class="methodSignature"><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>&nbsp;getProtocolData()</pre>
<div class="block">this is to be used with anything specific on a protocol head.</div>
</li>
</ul>
<a id="setProtocolData(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProtocolData</h4>
<pre class="methodSignature">void&nbsp;setProtocolData&#8203;(<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>&nbsp;protocolData)</pre>
<div class="block">this is to be used with anything specific on a protocol head.</div>
</li>
</ul>
<a id="setProtocolContext(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProtocolContext</h4>
<pre class="methodSignature">void&nbsp;setProtocolContext&#8203;(<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>&nbsp;protocolContext)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>protocolContext</code> - </dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#getProtocolContext()"><code>getProtocolContext()</code></a></dd>
</dl>
</li>
</ul>
<a id="getProtocolContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocolContext</h4>
<pre class="methodSignature"><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>&nbsp;getProtocolContext()</pre>
<div class="block">An object set by the Protocol implementation.
it could be anything pre-determined by the implementation</div>
</li>
</ul>
<a id="getID()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getID</h4>
<pre class="methodSignature">long&nbsp;getID()</pre>
</li>
</ul>
<a id="getConnectionID()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionID</h4>
<pre class="methodSignature"><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>&nbsp;getConnectionID()</pre>
</li>
</ul>
<a id="close(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">void&nbsp;close&#8203;(boolean&nbsp;failed)
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="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="removeItself()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeItself</h4>
<pre class="methodSignature">void&nbsp;removeItself()
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>
<div class="block">This method is just to remove itself from Queues.
If for any reason during a close an exception occurred, the exception treatment
will call removeItself what should take the consumer out of any queues.</div>
<dl>
<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="cancelRefs(boolean,boolean,org.apache.activemq.artemis.core.transaction.Transaction)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancelRefs</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>&gt;&nbsp;cancelRefs&#8203;(boolean&nbsp;failed,
boolean&nbsp;lastConsumedAsDelivered,
<a href="../transaction/Transaction.html" title="interface in org.apache.activemq.artemis.core.transaction">Transaction</a>&nbsp;tx)
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="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="setStarted(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStarted</h4>
<pre class="methodSignature">void&nbsp;setStarted&#8203;(boolean&nbsp;started)</pre>
</li>
</ul>
<a id="receiveCredits(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receiveCredits</h4>
<pre class="methodSignature">void&nbsp;receiveCredits&#8203;(int&nbsp;credits)</pre>
</li>
</ul>
<a id="getQueue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueue</h4>
<pre class="methodSignature"><a href="Queue.html" title="interface in org.apache.activemq.artemis.core.server">Queue</a>&nbsp;getQueue()</pre>
</li>
</ul>
<a id="removeReferenceByID(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeReferenceByID</h4>
<pre class="methodSignature"><a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>&nbsp;removeReferenceByID&#8203;(long&nbsp;messageID)
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="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="backToDelivering(org.apache.activemq.artemis.core.server.MessageReference)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>backToDelivering</h4>
<pre class="methodSignature">void&nbsp;backToDelivering&#8203;(<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>&nbsp;reference)</pre>
<div class="block">Some protocols may choose to send the message back to delivering instead of redeliver.
For example openwire will redeliver through the client, so messages will go back to delivering list after rollback.</div>
</li>
</ul>
<a id="scanDeliveringReferences(boolean,java.util.function.Function,java.util.function.Function)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scanDeliveringReferences</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>&gt;&nbsp;scanDeliveringReferences&#8203;(boolean&nbsp;remove,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a>&lt;<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a>&gt;&nbsp;startFunction,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Function</a>&lt;<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>,&#8203;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang" class="externalLink">Boolean</a>&gt;&nbsp;endFunction)</pre>
</li>
</ul>
<a id="acknowledge(org.apache.activemq.artemis.core.transaction.Transaction,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acknowledge</h4>
<pre class="methodSignature"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang" class="externalLink">Long</a>&gt;&nbsp;acknowledge&#8203;(<a href="../transaction/Transaction.html" title="interface in org.apache.activemq.artemis.core.transaction">Transaction</a>&nbsp;tx,
long&nbsp;messageID)
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="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="individualAcknowledge(org.apache.activemq.artemis.core.transaction.Transaction,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>individualAcknowledge</h4>
<pre class="methodSignature">void&nbsp;individualAcknowledge&#8203;(<a href="../transaction/Transaction.html" title="interface in org.apache.activemq.artemis.core.transaction">Transaction</a>&nbsp;tx,
long&nbsp;messageID)
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="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="reject(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reject</h4>
<pre class="methodSignature">void&nbsp;reject&#8203;(long&nbsp;messageID)
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="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="individualCancel(long,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>individualCancel</h4>
<pre class="methodSignature">void&nbsp;individualCancel&#8203;(long&nbsp;messageID,
boolean&nbsp;failed)
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="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="forceDelivery(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceDelivery</h4>
<pre class="methodSignature">void&nbsp;forceDelivery&#8203;(long&nbsp;sequence)</pre>
</li>
</ul>
<a id="setTransferring(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransferring</h4>
<pre class="methodSignature">void&nbsp;setTransferring&#8203;(boolean&nbsp;transferring)</pre>
</li>
</ul>
<a id="isBrowseOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBrowseOnly</h4>
<pre class="methodSignature">boolean&nbsp;isBrowseOnly()</pre>
</li>
</ul>
<a id="getCreationTime()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreationTime</h4>
<pre class="methodSignature">long&nbsp;getCreationTime()</pre>
</li>
</ul>
<a id="getSessionID()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionID</h4>
<pre class="methodSignature"><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;getSessionID()</pre>
</li>
</ul>
<a id="metricsAcknowledge(org.apache.activemq.artemis.core.server.MessageReference,org.apache.activemq.artemis.core.transaction.Transaction)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>metricsAcknowledge</h4>
<pre class="methodSignature">void&nbsp;metricsAcknowledge&#8203;(<a href="MessageReference.html" title="interface in org.apache.activemq.artemis.core.server">MessageReference</a>&nbsp;ref,
<a href="../transaction/Transaction.html" title="interface in org.apache.activemq.artemis.core.transaction">Transaction</a>&nbsp;transaction)</pre>
<div class="block">This is needed when some protocols (OW) handle the acks themselves and need to update the metrics</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ref</code> - the message reference</dd>
<dd><code>transaction</code> - the tx</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/ServerConsumer.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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>