Class BasePartitioner

Abstract class for Liftbridge partitioner.

All custom implementations must implment the calculatePartition method.

Hierarchy

BasePartitioner
- KeyPartitioner
- RoundRobinPartitioner

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BasePartitioner(subject: string, key: string | Uint8Array, metadata: IMetadata): BasePartitioner

- Defined in partition.ts:35
Partitioner base class.

Custom partitioners are expected to extends this class and implement the calculatePartition method.

Parameters
- subject: string
- key: string | Uint8Array
- metadata: IMetadata
  
  Metadata object.
Returns BasePartitioner

Properties

Protected key

key: string

Protected metadata

metadata: IMetadata

Protected subject

subject: string

Methods

Abstract calculatePartition

calculatePartition(): number

- Defined in partition.ts:66
Calculate the partition for the given message.

Returns number

Partition to send the message to.

Protected getPartitionCount

getPartitionCount(): number

- Defined in partition.ts:52
Returns number