org.apache.pulsar.broker.service

Class HashRangeAutoSplitStickyKeyConsumerSelector

java.lang.Object

org.apache.pulsar.broker.service.HashRangeAutoSplitStickyKeyConsumerSelector

All Implemented Interfaces:

StickyKeyConsumerSelector

public class HashRangeAutoSplitStickyKeyConsumerSelector
extends Object
implements StickyKeyConsumerSelector

This is a consumer selector based fixed hash range. 1.Each consumer serves a fixed range of hash value 2.The whole range of hash value could be covered by all the consumers. 3.Once a consumer is removed, the left consumers could still serve the whole range. Initializing with a fixed hash range, by default 2 << 15. First consumer added, hash range looks like: 0 -> 65536(consumer-1) Second consumer added, will find a biggest range to split: 0 -> 32768(consumer-2) -> 65536(consumer-1) While a consumer removed, The range for this consumer will be taken over by other consumer, consumer-2 removed: 0 -> 65536(consumer-1) In this approach use skip list map to maintain the hash range and consumers. Select consumer will return the ceiling key of message key hashcode % range size.

Field Summary

Fields inherited from interface org.apache.pulsar.broker.service.StickyKeyConsumerSelector

DEFAULT_RANGE_SIZE

Constructor Summary

Constructors

Constructor and Description
HashRangeAutoSplitStickyKeyConsumerSelector()
HashRangeAutoSplitStickyKeyConsumerSelector(int rangeSize)

Method Summary

Modifier and Type	Method and Description
void	addConsumer(Consumer consumer) Add a new consumer.
Map<Consumer,List<org.apache.pulsar.client.api.Range>>	getConsumerKeyHashRanges() Get key hash ranges handled by each consumer.
void	removeConsumer(Consumer consumer) Remove the consumer.
Consumer	select(int hash) Select a consumer by hash.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.broker.service.StickyKeyConsumerSelector

makeStickyKeyHash, select

Constructor Detail

HashRangeAutoSplitStickyKeyConsumerSelector

public HashRangeAutoSplitStickyKeyConsumerSelector()

HashRangeAutoSplitStickyKeyConsumerSelector

public HashRangeAutoSplitStickyKeyConsumerSelector(int rangeSize)

Method Detail

addConsumer

public void addConsumer(Consumer consumer)
                 throws BrokerServiceException.ConsumerAssignException

Description copied from interface: StickyKeyConsumerSelector

Add a new consumer.

Specified by:

addConsumer in interface StickyKeyConsumerSelector

Parameters:

consumer - new consumer

Throws:

BrokerServiceException.ConsumerAssignException

removeConsumer

public void removeConsumer(Consumer consumer)

Description copied from interface: StickyKeyConsumerSelector

Remove the consumer.

Specified by:

removeConsumer in interface StickyKeyConsumerSelector

Parameters:

consumer - consumer to be removed

select

public Consumer select(int hash)

Description copied from interface: StickyKeyConsumerSelector

Select a consumer by hash.

Specified by:

select in interface StickyKeyConsumerSelector

Parameters:

hash - hash corresponding to sticky key

Returns:

consumer

getConsumerKeyHashRanges

public Map<Consumer,List<org.apache.pulsar.client.api.Range>> getConsumerKeyHashRanges()

Description copied from interface: StickyKeyConsumerSelector

Get key hash ranges handled by each consumer.

Specified by:

getConsumerKeyHashRanges in interface StickyKeyConsumerSelector

Returns:

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