io.openmessaging.consumer

Interface Consumer

All Superinterfaces:

Client, Extension, ServiceLifecycle

All Known Subinterfaces:

PullConsumer, PushConsumer

public interface Consumer
extends ServiceLifecycle, Client

A PushConsumer receives messages from multiple queues, these messages are pushed from MOM server to Consumer client.

Since:

OMS 1.0.0

Version:

OMS 1.0.0

Method Summary

Modifier and Type	Method and Description
void	ack(MessageReceipt receipt) Acknowledges the specified and consumed message with the unique message receipt handle, in the scenario of using manual commit.
void	addInterceptor(ConsumerInterceptor interceptor) Adds a ConsumerInterceptor instance to this consumer.
Set<String>	getBindQueues() This method is used to find out the collection of queues bind to Consumer.
void	removeInterceptor(ConsumerInterceptor interceptor) Removes an interceptor from this consumer.

Methods inherited from interface io.openmessaging.ServiceLifecycle

currentState, start, stop

Methods inherited from interface io.openmessaging.extension.Extension

getQueueMetaData

Methods inherited from interface io.openmessaging.Client

getExtension

Method Detail

getBindQueues

Set<String> getBindQueues()

This method is used to find out the collection of queues bind to Consumer.

Returns:

the queues this consumer is bind, or null if the consumer is not bind queue.

addInterceptor

void addInterceptor(ConsumerInterceptor interceptor)

Adds a ConsumerInterceptor instance to this consumer.

Parameters:

interceptor - an interceptor instance.

removeInterceptor

void removeInterceptor(ConsumerInterceptor interceptor)

Removes an interceptor from this consumer.

Parameters:

interceptor - an interceptor to be removed.

ack

void ack(MessageReceipt receipt)

Acknowledges the specified and consumed message with the unique message receipt handle, in the scenario of using manual commit.

Messages that have been received but not acknowledged may be redelivered.

Parameters:

receipt - the receipt handle associated with the consumed message.