Kafka.Consumer.Subscription

Module with subscription types and functions.

Documentation

data Subscription

A consumer subscription to a topic.

Examples

Typically you don't call the constructor directly, but combine settings:

consumerSub :: Subscription
consumerSub = topics [TopicName "kafka-client-example-topic"]
           <> offsetReset Earliest
           <> extraSubscriptionProps (fromList [("prop1", "value 1"), ("prop2", "value 2")])

Constructors

Subscription (Set TopicName) (Map Text Text)

Instances

Semigroup Subscription

Defined in Kafka.Consumer.Subscription

Methods

(<>) :: Subscription -> Subscription -> Subscription

sconcat :: NonEmpty Subscription -> Subscription

stimes :: Integral b => b -> Subscription -> Subscription

Monoid Subscription

Defined in Kafka.Consumer.Subscription

Methods

mempty :: Subscription

mappend :: Subscription -> Subscription -> Subscription

mconcat :: [Subscription] -> Subscription

topics :: [TopicName] -> Subscription

Build a subscription by giving the list of topic names only

offsetReset :: OffsetReset -> Subscription

Build a subscription by giving the offset reset parameter only

extraSubscriptionProps :: Map Text Text -> Subscription

Build a subscription by giving extra properties only