org.apache.pulsar.broker.service

Interface StickyKeyConsumerSelector

All Known Implementing Classes:

ConsistentHashingStickyKeyConsumerSelector, HashRangeAutoSplitStickyKeyConsumerSelector, HashRangeExclusiveStickyKeyConsumerSelector

public interface StickyKeyConsumerSelector

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RANGE_SIZE

Method Summary

Modifier and Type	Method and Description
void	addConsumer(Consumer consumer) Add a new consumer
Map<String,List<String>>	getConsumerKeyHashRanges() Get key hash ranges handled by each consumer
void	removeConsumer(Consumer consumer) Remove the consumer
Consumer	select(byte[] stickyKey) Select a consumer by sticky key

Field Detail

DEFAULT_RANGE_SIZE

static final int DEFAULT_RANGE_SIZE

See Also:

Constant Field Values

Method Detail

addConsumer

void addConsumer(Consumer consumer)
          throws BrokerServiceException.ConsumerAssignException

Add a new consumer

Parameters:

consumer - new consumer

Throws:

BrokerServiceException.ConsumerAssignException

removeConsumer

void removeConsumer(Consumer consumer)

Remove the consumer

Parameters:

consumer - consumer to be removed

select

Consumer select(byte[] stickyKey)

Select a consumer by sticky key

Parameters:

stickyKey - sticky key

Returns:

consumer

getConsumerKeyHashRanges

Map<String,List<String>> getConsumerKeyHashRanges()

Get key hash ranges handled by each consumer

Returns:

A map where key is a consumer name and value is list of hash range it receiving message for.