blob: 4bc447c9a52894f9e52e41c2436a7e456c426f8c [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ClientProducerImpl (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="ClientProducerImpl (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};
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/ClientProducerImpl.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><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>Field&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 ClientProducerImpl" class="title">Class ClientProducerImpl</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.ClientProducerImpl</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/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code>, <code><a href="ClientProducerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientProducerInternal</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">ClientProducerImpl</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="ClientProducerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientProducerInternal</a></pre>
<div class="block">The client-side Producer.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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.api.core.SimpleString,org.apache.activemq.artemis.utils.TokenBucketLimiter,boolean,boolean,boolean,org.apache.activemq.artemis.api.core.SimpleString,int,org.apache.activemq.artemis.spi.core.remoting.SessionContext,int)">ClientProducerImpl</a></span>&#8203;(<a href="ClientSessionInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientSessionInternal</a>&nbsp;session,
<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;address,
org.apache.activemq.artemis.utils.TokenBucketLimiter&nbsp;rateLimiter,
boolean&nbsp;blockOnNonDurableSend,
boolean&nbsp;blockOnDurableSend,
boolean&nbsp;autoGroup,
<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;groupID,
int&nbsp;minLargeMessageSize,
<a href="../../../spi/core/remoting/SessionContext.html" title="class in org.apache.activemq.artemis.spi.core.remoting">SessionContext</a>&nbsp;sessionContext,
int&nbsp;producerID)</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="#cleanUp()">cleanUp</a></span>()</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="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Closes the ClientProducer.</div>
</td>
</tr>
<tr id="i2" 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="#getAddress()">getAddress</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the address where messages will be sent.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</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="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxRate()">getMaxRate</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the maximum rate at which a ClientProducer can send messages per second.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ClientProducerCredits.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientProducerCredits</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProducerCredits()">getProducerCredits</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBlockOnDurableSend()">isBlockOnDurableSend</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the producer will block when sending <em>durable</em> messages.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBlockOnNonDurableSend()">isBlockOnNonDurableSend</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether the producer will block when sending <em>non-durable</em> messages.</div>
</td>
</tr>
<tr id="i8" 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 producer is closed or not.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(java.lang.String,org.apache.activemq.artemis.api.core.Message)">send</a></span>&#8203;(<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;address1,
<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>&nbsp;message)</code></th>
<td class="colLast">
<div class="block">Sends a message to the specified address instead of the ClientProducer's address.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(org.apache.activemq.artemis.api.core.Message)">send</a></span>&#8203;(<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>&nbsp;msg)</code></th>
<td class="colLast">
<div class="block">Sends a message to an address.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler)">send</a></span>&#8203;(<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>&nbsp;message,
<a href="../../../api/core/client/SendAcknowledgementHandler.html" title="interface in org.apache.activemq.artemis.api.core.client">SendAcknowledgementHandler</a>&nbsp;handler)</code></th>
<td class="colLast">
<div class="block">Sends a message to the specified address instead of the ClientProducer's address.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.Message)">send</a></span>&#8203;(<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;address1,
<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>&nbsp;msg)</code></th>
<td class="colLast">
<div class="block">Sends a message to the specified address instead of the ClientProducer's address.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler)">send</a></span>&#8203;(<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;address1,
<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>&nbsp;message,
<a href="../../../api/core/client/SendAcknowledgementHandler.html" title="interface in org.apache.activemq.artemis.api.core.client">SendAcknowledgementHandler</a>&nbsp;handler)</code></th>
<td class="colLast">
<div class="block">Sends a message to the specified address instead of the ClientProducer's address.</div>
</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#toString()" title="class or interface in java.lang" class="externalLink">toString</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">
<!-- ========= 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.api.core.SimpleString,org.apache.activemq.artemis.utils.TokenBucketLimiter,boolean,boolean,boolean,org.apache.activemq.artemis.api.core.SimpleString,int,org.apache.activemq.artemis.spi.core.remoting.SessionContext,int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ClientProducerImpl</h4>
<pre>public&nbsp;ClientProducerImpl&#8203;(<a href="ClientSessionInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientSessionInternal</a>&nbsp;session,
<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;address,
org.apache.activemq.artemis.utils.TokenBucketLimiter&nbsp;rateLimiter,
boolean&nbsp;blockOnNonDurableSend,
boolean&nbsp;blockOnDurableSend,
boolean&nbsp;autoGroup,
<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;groupID,
int&nbsp;minLargeMessageSize,
<a href="../../../spi/core/remoting/SessionContext.html" title="class in org.apache.activemq.artemis.spi.core.remoting">SessionContext</a>&nbsp;sessionContext,
int&nbsp;producerID)</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="getAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAddress</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;getAddress()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientProducer.html#getAddress()">ClientProducer</a></code></span></div>
<div class="block">Returns the address where messages will be sent.
<br><br>The address can be <code>null</code> if the ClientProducer
was creating without specifying an address, that is by using <a href="../../../api/core/client/ClientSession.html#createProducer()"><code>ClientSession.createProducer()</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#getAddress()">getAddress</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the address where messages will be sent</dd>
</dl>
</li>
</ul>
<a id="send(org.apache.activemq.artemis.api.core.Message)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;send&#8203;(<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>&nbsp;msg)
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/ClientProducer.html#send(org.apache.activemq.artemis.api.core.Message)">ClientProducer</a></code></span></div>
<div class="block">Sends a message to an address. specified in <a href="../../../api/core/client/ClientSession.html#createProducer(java.lang.String)"><code>ClientSession.createProducer(String)</code></a> or
similar methods. <br>
<br>
This will block until confirmation that the message has reached the server has been received
if <a href="../../../api/core/client/ServerLocator.html#setBlockOnDurableSend(boolean)"><code>ServerLocator.setBlockOnDurableSend(boolean)</code></a> or
<a href="../../../api/core/client/ServerLocator.html#setBlockOnNonDurableSend(boolean)"><code>ServerLocator.setBlockOnNonDurableSend(boolean)</code></a> are set to <code>true</code> for the
specified message type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#send(org.apache.activemq.artemis.api.core.Message)">send</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>msg</code> - the message to send</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 sending the message</dd>
</dl>
</li>
</ul>
<a id="send(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.Message)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;send&#8203;(<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;address1,
<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>&nbsp;msg)
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/ClientProducer.html#send(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.Message)">ClientProducer</a></code></span></div>
<div class="block">Sends a message to the specified address instead of the ClientProducer's address. <br>
<br>
This will block until confirmation that the message has reached the server has been received
if <a href="../../../api/core/client/ServerLocator.html#setBlockOnDurableSend(boolean)"><code>ServerLocator.setBlockOnDurableSend(boolean)</code></a> or
<a href="../../../api/core/client/ServerLocator.html#setBlockOnNonDurableSend(boolean)"><code>ServerLocator.setBlockOnNonDurableSend(boolean)</code></a> are set to true for the specified
message type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#send(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.Message)">send</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address1</code> - the address where the message will be sent</dd>
<dd><code>msg</code> - the message to send</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 sending the message</dd>
</dl>
</li>
</ul>
<a id="send(java.lang.String,org.apache.activemq.artemis.api.core.Message)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;send&#8203;(<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;address1,
<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</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>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientProducer.html#send(java.lang.String,org.apache.activemq.artemis.api.core.Message)">ClientProducer</a></code></span></div>
<div class="block">Sends a message to the specified address instead of the ClientProducer's address. <br>
<br>
This will block until confirmation that the message has reached the server has been received
if <a href="../../../api/core/client/ServerLocator.html#setBlockOnDurableSend(boolean)"><code>ServerLocator.setBlockOnDurableSend(boolean)</code></a> or
<a href="../../../api/core/client/ServerLocator.html#setBlockOnNonDurableSend(boolean)"><code>ServerLocator.setBlockOnNonDurableSend(boolean)</code></a> are set to true for the specified
message type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#send(java.lang.String,org.apache.activemq.artemis.api.core.Message)">send</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address1</code> - the address where the message will be sent</dd>
<dd><code>message</code> - the message to send</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 sending the message</dd>
</dl>
</li>
</ul>
<a id="send(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;send&#8203;(<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;address1,
<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>&nbsp;message,
<a href="../../../api/core/client/SendAcknowledgementHandler.html" title="interface in org.apache.activemq.artemis.api.core.client">SendAcknowledgementHandler</a>&nbsp;handler)
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/ClientProducer.html#send(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler)">ClientProducer</a></code></span></div>
<div class="block">Sends a message to the specified address instead of the ClientProducer's address. <br>
<br>
This message will be sent asynchronously as long as <a href="../../../api/core/client/ServerLocator.html#setConfirmationWindowSize(int)"><code>ServerLocator.setConfirmationWindowSize(int)</code></a> was set.
<p>
Notice that if no confirmationWindowsize is set</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#send(org.apache.activemq.artemis.api.core.SimpleString,org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler)">send</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address1</code> - the address where the message will be sent</dd>
<dd><code>message</code> - the message to send</dd>
<dd><code>handler</code> - handler to call after receiving a SEND acknowledgement from the server</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 sending the message</dd>
</dl>
</li>
</ul>
<a id="send(org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;send&#8203;(<a href="../../../api/core/Message.html" title="interface in org.apache.activemq.artemis.api.core">Message</a>&nbsp;message,
<a href="../../../api/core/client/SendAcknowledgementHandler.html" title="interface in org.apache.activemq.artemis.api.core.client">SendAcknowledgementHandler</a>&nbsp;handler)
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/ClientProducer.html#send(org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler)">ClientProducer</a></code></span></div>
<div class="block">Sends a message to the specified address instead of the ClientProducer's address. <br>
<br>
This message will be sent asynchronously.
<p>
The handler will only get called if <a href="../../../api/core/client/ServerLocator.html#setConfirmationWindowSize(int)"><code>-1</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#send(org.apache.activemq.artemis.api.core.Message,org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler)">send</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - the message to send</dd>
<dd><code>handler</code> - handler to call after receiving a SEND acknowledgement from the server</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 sending the message</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/ClientProducer.html#close()">ClientProducer</a></code></span></div>
<div class="block">Closes the ClientProducer. If already closed nothing is done.</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/ClientProducer.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</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> - if an exception occurs while closing the producer</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="ClientProducerInternal.html#cleanUp()">cleanUp</a></code>&nbsp;in interface&nbsp;<code><a href="ClientProducerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientProducerInternal</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/ClientProducer.html#isClosed()">ClientProducer</a></code></span></div>
<div class="block">Returns whether the producer is closed or not.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#isClosed()">isClosed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the producer is closed, <code>false</code> else</dd>
</dl>
</li>
</ul>
<a id="isBlockOnDurableSend()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBlockOnDurableSend</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isBlockOnDurableSend()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientProducer.html#isBlockOnDurableSend()">ClientProducer</a></code></span></div>
<div class="block">Returns whether the producer will block when sending <em>durable</em> messages.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#isBlockOnDurableSend()">isBlockOnDurableSend</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the producer blocks when sending durable, <code>false</code> else</dd>
</dl>
</li>
</ul>
<a id="isBlockOnNonDurableSend()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBlockOnNonDurableSend</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isBlockOnNonDurableSend()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientProducer.html#isBlockOnNonDurableSend()">ClientProducer</a></code></span></div>
<div class="block">Returns whether the producer will block when sending <em>non-durable</em> messages.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#isBlockOnNonDurableSend()">isBlockOnNonDurableSend</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the producer blocks when sending non-durable, <code>false</code> else</dd>
</dl>
</li>
</ul>
<a id="getMaxRate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxRate</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMaxRate()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/core/client/ClientProducer.html#getMaxRate()">ClientProducer</a></code></span></div>
<div class="block">Returns the maximum rate at which a ClientProducer can send messages per second.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/core/client/ClientProducer.html#getMaxRate()">getMaxRate</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/core/client/ClientProducer.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientProducer</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the producers maximum rate</dd>
</dl>
</li>
</ul>
<a id="getProducerCredits()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProducerCredits</h4>
<pre class="methodSignature">public&nbsp;<a href="ClientProducerCredits.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientProducerCredits</a>&nbsp;getProducerCredits()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientProducerInternal.html#getProducerCredits()">getProducerCredits</a></code>&nbsp;in interface&nbsp;<code><a href="ClientProducerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientProducerInternal</a></code></dd>
</dl>
</li>
</ul>
<a id="getID()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getID</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getID()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ClientProducerInternal.html#getID()">getID</a></code>&nbsp;in interface&nbsp;<code><a href="ClientProducerInternal.html" title="interface in org.apache.activemq.artemis.core.client.impl">ClientProducerInternal</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/ClientProducerImpl.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><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>Field&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>