Package org.apache.pulsar.broker.service

Class HashRangeExclusiveStickyKeyConsumerSelector

java.lang.Object

org.apache.pulsar.broker.service.HashRangeExclusiveStickyKeyConsumerSelector

All Implemented Interfaces:

StickyKeyConsumerSelector

public class HashRangeExclusiveStickyKeyConsumerSelector
extends java.lang.Object
implements StickyKeyConsumerSelector

This is a sticky-key consumer selector based user provided range. User is responsible for making sure provided range for all consumers cover the rangeSize else there'll be chance that a key fall in a `whole` that not handled by any consumer.

Field Summary

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

DEFAULT_RANGE_SIZE

Constructor Summary

Constructors

Constructor	Description
HashRangeExclusiveStickyKeyConsumerSelector()
HashRangeExclusiveStickyKeyConsumerSelector(int rangeSize)

Method Summary

Modifier and Type	Method	Description
void	addConsumer(Consumer consumer)	Add a new consumer.
java.util.Map<Consumer,java.util.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

select

Constructor Detail

HashRangeExclusiveStickyKeyConsumerSelector

public HashRangeExclusiveStickyKeyConsumerSelector()

HashRangeExclusiveStickyKeyConsumerSelector

public HashRangeExclusiveStickyKeyConsumerSelector(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

getConsumerKeyHashRanges

public java.util.Map<Consumer,java.util.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.

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