Package org.apache.pulsar.client.api

Interface MessageAcknowledger

All Known Subinterfaces:

Consumer<T>

public interface MessageAcknowledger

The interface to acknowledge one or more messages individually or cumulatively.

It contains two methods of various overloads: - `acknowledge`: acknowledge individually - `acknowledgeCumulative`: acknowledge cumulatively Each of them has an associated asynchronous API that has the "Async" suffix in the name.

The 1st method parameter is - MessageId or Message when acknowledging a single message - List<MessageId> or Messages when acknowledging multiple messages

The 2nd method parameter is optional. Specify a non-null Transaction instance for transaction usages: - After the transaction is committed, the message will be actually acknowledged (individually or cumulatively). - After the transaction is aborted, the message will be redelivered.

See Also:

• Transaction.commit()
• Transaction.abort()

Method Summary

Modifier and Type	Method	Description
void	acknowledge(List<MessageId> messageIdList)	Acknowledge the consumption of a list of message.
default void	acknowledge(Message<?> message)
void	acknowledge(MessageId messageId)	Acknowledge the consumption of a single message.
default void	acknowledge(Messages<?> messages)
CompletableFuture<Void>	acknowledgeAsync(List<MessageId> messageIdList)	The asynchronous version of acknowledge(List).
CompletableFuture<Void>	acknowledgeAsync(List<MessageId> messageIdList, Transaction txn)	The asynchronous version of acknowledge(List) with transaction support.
CompletableFuture<Void>	acknowledgeAsync(Message<?> message)	The asynchronous version of acknowledge(Message).
default CompletableFuture<Void>	acknowledgeAsync(MessageId messageId)	The asynchronous version of acknowledge(MessageId).
CompletableFuture<Void>	acknowledgeAsync(MessageId messageId, Transaction txn)	The asynchronous version of acknowledge(MessageId) with transaction support.
CompletableFuture<Void>	acknowledgeAsync(Messages<?> messages)	The asynchronous version of acknowledge(Messages).
CompletableFuture<Void>	acknowledgeAsync(Messages<?> messages, Transaction txn)	The asynchronous version of acknowledge(Messages) with transaction support.
default void	acknowledgeCumulative(Message<?> message)
void	acknowledgeCumulative(MessageId messageId)	Acknowledge the reception of all the messages in the stream up to (and including) the provided message.
default CompletableFuture<Void>	acknowledgeCumulativeAsync(Message<?> message)	The asynchronous version of acknowledgeCumulative(Message).
default CompletableFuture<Void>	acknowledgeCumulativeAsync(MessageId messageId)	The asynchronous version of acknowledgeCumulative(MessageId).
CompletableFuture<Void>	acknowledgeCumulativeAsync(MessageId messageId, Transaction txn)	The asynchronous version of acknowledgeCumulative(MessageId) with transaction support.

Method Details

acknowledge

void acknowledge(MessageId messageId)
          throws PulsarClientException

Acknowledge the consumption of a single message.

Parameters:

messageId - MessageId to be individual acknowledged

Throws:

PulsarClientException.AlreadyClosedException - } if the consumer was already closed

PulsarClientException.NotAllowedException - if `messageId` is not a TopicMessageId when multiple topics are subscribed

PulsarClientException

acknowledge

default void acknowledge(Message<?> message)
                  throws PulsarClientException

Throws:

PulsarClientException

acknowledge

void acknowledge(List<MessageId> messageIdList)
          throws PulsarClientException

Acknowledge the consumption of a list of message.

Parameters:

messageIdList - the list of message IDs.

Throws:

PulsarClientException.NotAllowedException - if any message id in the list is not a TopicMessageId when multiple topics are subscribed

PulsarClientException

acknowledge

default void acknowledge(Messages<?> messages)
                  throws PulsarClientException

Throws:

PulsarClientException

acknowledgeCumulative

void acknowledgeCumulative(MessageId messageId)
                    throws PulsarClientException

Acknowledge the reception of all the messages in the stream up to (and including) the provided message.

This method will block until the acknowledge has been sent to the broker. After that, the messages will not be re-delivered to this consumer.

Cumulative acknowledge cannot be used when the consumer type is set to ConsumerShared.

It's equivalent to calling asyncAcknowledgeCumulative(MessageId) and waiting for the callback to be triggered.

Parameters:

messageId - The MessageId to be cumulatively acknowledged

Throws:

PulsarClientException.AlreadyClosedException - if the consumer was already closed

PulsarClientException.NotAllowedException - if `messageId` is not a TopicMessageId when multiple topics are subscribed

PulsarClientException

acknowledgeCumulative

default void acknowledgeCumulative(Message<?> message)
                            throws PulsarClientException

Throws:

PulsarClientException

acknowledgeAsync

CompletableFuture<Void> acknowledgeAsync(MessageId messageId,
 Transaction txn)

The asynchronous version of acknowledge(MessageId) with transaction support.

acknowledgeAsync

default CompletableFuture<Void> acknowledgeAsync(MessageId messageId)

The asynchronous version of acknowledge(MessageId).

acknowledgeAsync

CompletableFuture<Void> acknowledgeAsync(List<MessageId> messageIdList,
 Transaction txn)

The asynchronous version of acknowledge(List) with transaction support.

acknowledgeAsync

CompletableFuture<Void> acknowledgeAsync(List<MessageId> messageIdList)

The asynchronous version of acknowledge(List).

acknowledgeAsync

CompletableFuture<Void> acknowledgeAsync(Message<?> message)

The asynchronous version of acknowledge(Message).

acknowledgeAsync

CompletableFuture<Void> acknowledgeAsync(Messages<?> messages)

The asynchronous version of acknowledge(Messages).

acknowledgeAsync

CompletableFuture<Void> acknowledgeAsync(Messages<?> messages,
 Transaction txn)

The asynchronous version of acknowledge(Messages) with transaction support.

acknowledgeCumulativeAsync

CompletableFuture<Void> acknowledgeCumulativeAsync(MessageId messageId,
 Transaction txn)

The asynchronous version of acknowledgeCumulative(MessageId) with transaction support.

Parameters:

messageId - The MessageId to be cumulatively acknowledged

txn - Transaction the transaction to cumulative ack

acknowledgeCumulativeAsync

default CompletableFuture<Void> acknowledgeCumulativeAsync(Message<?> message)

The asynchronous version of acknowledgeCumulative(Message).

acknowledgeCumulativeAsync

default CompletableFuture<Void> acknowledgeCumulativeAsync(MessageId messageId)

The asynchronous version of acknowledgeCumulative(MessageId).