org.apache.activemq.artemis.core.client.impl

Class ClientProducerImpl

java.lang.Object

org.apache.activemq.artemis.core.client.impl.ClientProducerImpl

All Implemented Interfaces:

AutoCloseable, ClientProducer, ClientProducerInternal

public class ClientProducerImpl
extends Object
implements ClientProducerInternal

The client-side Producer.

Constructor Summary

Constructors

Constructor and Description
ClientProducerImpl(ClientSessionInternal session, SimpleString address, TokenBucketLimiter rateLimiter, boolean blockOnNonDurableSend, boolean blockOnDurableSend, boolean autoGroup, SimpleString groupID, int minLargeMessageSize, SessionContext sessionContext)

Method Summary

Modifier and Type	Method and Description
void	cleanUp()
void	close() Closes the ClientProducer.
SimpleString	getAddress() Returns the address where messages will be sent.
int	getMaxRate() Returns the maximum rate at which a ClientProducer can send messages per second.
ClientProducerCredits	getProducerCredits()
boolean	isBlockOnDurableSend() Returns whether the producer will block when sending durable messages.
boolean	isBlockOnNonDurableSend() Returns whether the producer will block when sending non-durable messages.
boolean	isClosed() Returns whether the producer is closed or not.
void	send(Message msg) Sends a message to an address.
void	send(Message message, SendAcknowledgementHandler handler) Sends a message to the specified address instead of the ClientProducer's address.
void	send(SimpleString address1, Message msg) Sends a message to the specified address instead of the ClientProducer's address.
void	send(SimpleString address1, Message message, SendAcknowledgementHandler handler) Sends a message to the specified address instead of the ClientProducer's address.
void	send(String address1, Message message) Sends a message to the specified address instead of the ClientProducer's address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientProducerImpl

public ClientProducerImpl(ClientSessionInternal session,
                          SimpleString address,
                          TokenBucketLimiter rateLimiter,
                          boolean blockOnNonDurableSend,
                          boolean blockOnDurableSend,
                          boolean autoGroup,
                          SimpleString groupID,
                          int minLargeMessageSize,
                          SessionContext sessionContext)

Method Detail

getAddress

public SimpleString getAddress()

Description copied from interface: ClientProducer

Returns the address where messages will be sent.

The address can be null if the ClientProducer was creating without specifying an address, that is by using ClientSession.createProducer().

Specified by:

getAddress in interface ClientProducer

Returns:

the address where messages will be sent

send

public void send(Message msg)
          throws ActiveMQException

Description copied from interface: ClientProducer

Sends a message to an address. specified in ClientSession.createProducer(String) or similar methods.

This will block until confirmation that the message has reached the server has been received if ServerLocator.setBlockOnDurableSend(boolean) or ServerLocator.setBlockOnNonDurableSend(boolean) are set to true for the specified message type.

Specified by:

send in interface ClientProducer

Parameters:

msg - the message to send

Throws:

ActiveMQException - if an exception occurs while sending the message

send

public void send(SimpleString address1,
                 Message msg)
          throws ActiveMQException

Description copied from interface: ClientProducer

Sends a message to the specified address instead of the ClientProducer's address.

This will block until confirmation that the message has reached the server has been received if ServerLocator.setBlockOnDurableSend(boolean) or ServerLocator.setBlockOnNonDurableSend(boolean) are set to true for the specified message type.

Specified by:

send in interface ClientProducer

Parameters:

address1 - the address where the message will be sent

msg - the message to send

Throws:

ActiveMQException - if an exception occurs while sending the message

send

public void send(String address1,
                 Message message)
          throws ActiveMQException

Description copied from interface: ClientProducer

Sends a message to the specified address instead of the ClientProducer's address.

This will block until confirmation that the message has reached the server has been received if ServerLocator.setBlockOnDurableSend(boolean) or ServerLocator.setBlockOnNonDurableSend(boolean) are set to true for the specified message type.

Specified by:

send in interface ClientProducer

Parameters:

address1 - the address where the message will be sent

message - the message to send

Throws:

ActiveMQException - if an exception occurs while sending the message

send

public void send(SimpleString address1,
                 Message message,
                 SendAcknowledgementHandler handler)
          throws ActiveMQException

Description copied from interface: ClientProducer

Sends a message to the specified address instead of the ClientProducer's address.

This message will be sent asynchronously.

The handler will only get called if -1.

Specified by:

send in interface ClientProducer

Parameters:

address1 - the address where the message will be sent

message - the message to send

handler - handler to call after receiving a SEND acknowledgement from the server

Throws:

ActiveMQException - if an exception occurs while sending the message

send

public void send(Message message,
                 SendAcknowledgementHandler handler)
          throws ActiveMQException

Description copied from interface: ClientProducer

Sends a message to the specified address instead of the ClientProducer's address.

This message will be sent asynchronously.

The handler will only get called if -1.

Specified by:

send in interface ClientProducer

Parameters:

message - the message to send

handler - handler to call after receiving a SEND acknowledgement from the server

Throws:

ActiveMQException - if an exception occurs while sending the message

close

public void close()
           throws ActiveMQException

Description copied from interface: ClientProducer

Closes the ClientProducer. If already closed nothing is done.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ClientProducer

Throws:

ActiveMQException - if an exception occurs while closing the producer

cleanUp

public void cleanUp()

Specified by:

cleanUp in interface ClientProducerInternal

isClosed

public boolean isClosed()

Description copied from interface: ClientProducer

Returns whether the producer is closed or not.

Specified by:

isClosed in interface ClientProducer

Returns:

true if the producer is closed, false else

isBlockOnDurableSend

public boolean isBlockOnDurableSend()

Description copied from interface: ClientProducer

Returns whether the producer will block when sending durable messages.

Specified by:

isBlockOnDurableSend in interface ClientProducer

Returns:

true if the producer blocks when sending durable, false else

isBlockOnNonDurableSend

public boolean isBlockOnNonDurableSend()

Description copied from interface: ClientProducer

Returns whether the producer will block when sending non-durable messages.

Specified by:

isBlockOnNonDurableSend in interface ClientProducer

Returns:

true if the producer blocks when sending non-durable, false else

getMaxRate

public int getMaxRate()

Description copied from interface: ClientProducer

Returns the maximum rate at which a ClientProducer can send messages per second.

Specified by:

getMaxRate in interface ClientProducer

Returns:

the producers maximum rate

getProducerCredits

public ClientProducerCredits getProducerCredits()

Specified by:

getProducerCredits in interface ClientProducerInternal