接口的使用
org.apache.pulsar.client.api.Message

使用Message的程序包

程序包	说明
org.apache.pulsar.client.api	Pulsar Client API.
org.apache.pulsar.client.api.interceptor	Pulsar interceptors.

org.apache.pulsar.client.api中Message的使用

返回Message的org.apache.pulsar.client.api中的方法

修饰符和类型	方法	说明
<T> Message<T>	MessagePayloadContext.asSingleMessage(MessagePayload payload, Schema<T> schema)	Convert the given payload to a single message if the entry is not a batch.
Message<T>	ConsumerInterceptor.beforeConsume(Consumer<T> consumer, Message<T> message)	This is called just before the message is returned by Consumer.receive(), MessageListener.received(Consumer, Message) or the CompletableFuture returned by Consumer.receiveAsync() completes.
Message<T>	ReaderInterceptor.beforeRead(Reader<T> reader, Message<T> message)	This is called just before the message is returned by Reader.readNext(), ReaderListener.received(Reader, Message) or the CompletableFuture returned by Reader.readNextAsync() completes.
Message<T>	ProducerInterceptor.beforeSend(Producer<T> producer, Message<T> message)	已过时。 This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before send the message to the brokers.
<T> Message<T>	MessagePayloadContext.getMessageAt(int index, int numMessages, MessagePayload payload, boolean containMetadata, Schema<T> schema)	Get the internal single message with a specific index from a payload if the payload is a batch.
Message<T>	Reader.readNext()	Read the next message in the topic.
Message<T>	Reader.readNext(int timeout, TimeUnit unit)	Read the next message in the topic waiting for a maximum time.
Message<T>	Consumer.receive()	Receives a single message.
Message<T>	Consumer.receive(int timeout, TimeUnit unit)	Receive a single message.

返回变量类型为Message的类型的org.apache.pulsar.client.api中的方法

修饰符和类型	方法	说明
CompletableFuture<Message<T>>	Reader.readNextAsync()	Read asynchronously the next message in the topic.
CompletableFuture<Message<T>>	Consumer.receiveAsync()	Receive a single message

参数类型为Message的org.apache.pulsar.client.api中的方法

修饰符和类型	方法	说明
default void	MessageAcknowledger.acknowledge(Message<?> message)
CompletableFuture<Void>	MessageAcknowledger.acknowledgeAsync(Message<?> message)	The asynchronous version of MessageAcknowledger.acknowledge(Message).
default void	MessageAcknowledger.acknowledgeCumulative(Message<?> message)
default CompletableFuture<Void>	MessageAcknowledger.acknowledgeCumulativeAsync(Message<?> message)	The asynchronous version of MessageAcknowledger.acknowledgeCumulative(Message).
Message<T>	ConsumerInterceptor.beforeConsume(Consumer<T> consumer, Message<T> message)	This is called just before the message is returned by Consumer.receive(), MessageListener.received(Consumer, Message) or the CompletableFuture returned by Consumer.receiveAsync() completes.
Message<T>	ReaderInterceptor.beforeRead(Reader<T> reader, Message<T> message)	This is called just before the message is returned by Reader.readNext(), ReaderListener.received(Reader, Message) or the CompletableFuture returned by Reader.readNextAsync() completes.
Message<T>	ProducerInterceptor.beforeSend(Producer<T> producer, Message<T> message)	已过时。 This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before send the message to the brokers.
default int	MessageRouter.choosePartition(Message<?> msg)	已过时。 since 1.22.0.
default int	MessageRouter.choosePartition(Message<?> msg, TopicMetadata metadata)	Choose a partition based on msg and the topic metadata.
void	Consumer.negativeAcknowledge(Message<?> message)	Acknowledge the failure to process a single message.
void	ProducerInterceptor.onSendAcknowledgement(Producer<T> producer, Message<T> message, MessageId msgId, Throwable exception)	已过时。 This method is called when the message sent to the broker has been acknowledged, or when sending the message fails.
void	MessageListener.received(Consumer<T> consumer, Message<T> msg)	This method is called whenever a new message is received.
void	ReaderListener.received(Reader<T> reader, Message<T> msg)	This method is called whenever a new message is received.
void	Consumer.reconsumeLater(Message<?> message, long delayTime, TimeUnit unit)	reconsumeLater the consumption of Messages.
void	Consumer.reconsumeLater(Message<?> message, Map<String,String> customProperties, long delayTime, TimeUnit unit)	reconsumeLater the consumption of Messages.
CompletableFuture<Void>	Consumer.reconsumeLaterAsync(Message<?> message, long delayTime, TimeUnit unit)	Asynchronously reconsumeLater the consumption of a single message.
CompletableFuture<Void>	Consumer.reconsumeLaterAsync(Message<?> message, Map<String,String> customProperties, long delayTime, TimeUnit unit)	Asynchronously reconsumeLater the consumption of a single message.
void	Consumer.reconsumeLaterCumulative(Message<?> message, long delayTime, TimeUnit unit)	reconsumeLater the reception of all the messages in the stream up to (and including) the provided message.
CompletableFuture<Void>	Consumer.reconsumeLaterCumulativeAsync(Message<?> message, long delayTime, TimeUnit unit)	Asynchronously ReconsumeLater the reception of all the messages in the stream up to (and including) the provided message.
CompletableFuture<Void>	Consumer.reconsumeLaterCumulativeAsync(Message<?> message, Map<String,String> customProperties, long delayTime, TimeUnit unit)	Asynchronously ReconsumeLater the reception of all the messages in the stream up to (and including) the provided message.

类型变量类型为Message的org.apache.pulsar.client.api中的方法参数

修饰符和类型	方法	说明
<T> void	MessagePayloadProcessor.process(MessagePayload payload, MessagePayloadContext context, Schema<T> schema, Consumer<Message<T>> messageConsumer)	Process the message payload.

org.apache.pulsar.client.api.interceptor中Message的使用

返回Message的org.apache.pulsar.client.api.interceptor中的方法

修饰符和类型	方法	说明
Message	ProducerInterceptor.beforeSend(Producer producer, Message message)	This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before send the message to the brokers.
Message	ProducerInterceptorWrapper.beforeSend(Producer producer, Message message)

参数类型为Message的org.apache.pulsar.client.api.interceptor中的方法

修饰符和类型	方法	说明
Message	ProducerInterceptor.beforeSend(Producer producer, Message message)	This is called from Producer.send(Object) and Producer.sendAsync(Object) methods, before send the message to the brokers.
Message	ProducerInterceptorWrapper.beforeSend(Producer producer, Message message)
boolean	ProducerInterceptor.eligible(Message message)	Check whether the interceptor is eligible for this message.
boolean	ProducerInterceptorWrapper.eligible(Message message)
void	ProducerInterceptor.onSendAcknowledgement(Producer producer, Message message, MessageId msgId, Throwable exception)	This method is called when the message sent to the broker has been acknowledged, or when sending the message fails.
void	ProducerInterceptorWrapper.onSendAcknowledgement(Producer producer, Message message, MessageId msgId, Throwable exception)