Kafka.Consumer.Types

Documentation

data KafkaConsumer

Constructors

KafkaConsumer

Fields

• kcKafkaPtr :: !Kafka
• kcKafkaConf :: !KafkaConf

newtype ConsumerGroupId

Constructors

ConsumerGroupId String

Instances

Eq ConsumerGroupId

Methods

(==) :: ConsumerGroupId -> ConsumerGroupId -> Bool

(/=) :: ConsumerGroupId -> ConsumerGroupId -> Bool

Show ConsumerGroupId

Methods

showsPrec :: Int -> ConsumerGroupId -> ShowS

show :: ConsumerGroupId -> String

showList :: [ConsumerGroupId] -> ShowS

newtype Offset

Constructors

Offset Int64

Instances

Eq Offset

Methods

(==) :: Offset -> Offset -> Bool

(/=) :: Offset -> Offset -> Bool

Read Offset

Methods

readsPrec :: Int -> ReadS Offset

readList :: ReadS [Offset]

readPrec :: ReadPrec Offset

readListPrec :: ReadPrec [Offset]

Show Offset

Methods

showsPrec :: Int -> Offset -> ShowS

show :: Offset -> String

showList :: [Offset] -> ShowS

data OffsetReset

Constructors

Earliest

Latest

Instances

Eq OffsetReset

Methods

(==) :: OffsetReset -> OffsetReset -> Bool

(/=) :: OffsetReset -> OffsetReset -> Bool

Show OffsetReset

Methods

showsPrec :: Int -> OffsetReset -> ShowS

show :: OffsetReset -> String

showList :: [OffsetReset] -> ShowS

data RebalanceEvent

A set of events which happen during the rebalancing process

Constructors

RebalanceBeforeAssign [(TopicName, PartitionId)]

Happens before Kafka Client confirms new assignment

RebalanceAssign [(TopicName, PartitionId)]

Happens after the new assignment is confirmed

RebalanceBeforeRevoke [(TopicName, PartitionId)]

Happens before Kafka Client confirms partitions rejection

RebalanceRevoke [(TopicName, PartitionId)]

Happens after the rejection is confirmed

Instances

Eq RebalanceEvent

Methods

(==) :: RebalanceEvent -> RebalanceEvent -> Bool

(/=) :: RebalanceEvent -> RebalanceEvent -> Bool

Show RebalanceEvent

Methods

showsPrec :: Int -> RebalanceEvent -> ShowS

show :: RebalanceEvent -> String

showList :: [RebalanceEvent] -> ShowS

data PartitionOffset

Constructors

PartitionOffsetBeginning

PartitionOffsetEnd

PartitionOffset Int64

PartitionOffsetStored

PartitionOffsetInvalid

Instances

Eq PartitionOffset

Methods

(==) :: PartitionOffset -> PartitionOffset -> Bool

(/=) :: PartitionOffset -> PartitionOffset -> Bool

Show PartitionOffset

Methods

showsPrec :: Int -> PartitionOffset -> ShowS

show :: PartitionOffset -> String

showList :: [PartitionOffset] -> ShowS

data SubscribedPartitions

Constructors

SubscribedPartitions [PartitionId]

SubscribedPartitionsAll

Instances

Eq SubscribedPartitions

Methods

(==) :: SubscribedPartitions -> SubscribedPartitions -> Bool

(/=) :: SubscribedPartitions -> SubscribedPartitions -> Bool

Show SubscribedPartitions

Methods

showsPrec :: Int -> SubscribedPartitions -> ShowS

show :: SubscribedPartitions -> String

showList :: [SubscribedPartitions] -> ShowS

data Timestamp

Constructors

CreateTime !Millis

LogAppendTime !Millis

NoTimestamp

Instances

Eq Timestamp

Methods

(==) :: Timestamp -> Timestamp -> Bool

(/=) :: Timestamp -> Timestamp -> Bool

Read Timestamp

Methods

readsPrec :: Int -> ReadS Timestamp

readList :: ReadS [Timestamp]

readPrec :: ReadPrec Timestamp

readListPrec :: ReadPrec [Timestamp]

Show Timestamp

Methods

showsPrec :: Int -> Timestamp -> ShowS

show :: Timestamp -> String

showList :: [Timestamp] -> ShowS

data OffsetCommit

Offsets commit mode

Constructors

OffsetCommit

Forces consumer to block until the broker offsets commit is done

OffsetCommitAsync

Offsets will be committed in a non-blocking way

Instances

Eq OffsetCommit

Methods

(==) :: OffsetCommit -> OffsetCommit -> Bool

(/=) :: OffsetCommit -> OffsetCommit -> Bool

Show OffsetCommit

Methods

showsPrec :: Int -> OffsetCommit -> ShowS

show :: OffsetCommit -> String

showList :: [OffsetCommit] -> ShowS

data OffsetStoreSync

Indicates how offsets are to be synced to disk

Constructors

OffsetSyncDisable

Do not sync offsets (in Kafka: -1)

OffsetSyncImmediate

Sync immediately after each offset commit (in Kafka: 0)

OffsetSyncInterval Int

Sync after specified interval in millis

data OffsetStoreMethod

Indicates the method of storing the offsets

Constructors

OffsetStoreBroker

Offsets are stored in Kafka broker (preferred)

OffsetStoreFile FilePath OffsetStoreSync

Offsets are stored in a file (and synced to disk according to the sync policy)

data TopicPartition

Kafka topic partition structure

Constructors

TopicPartition

Fields

• tpTopicName :: TopicName
• tpPartition :: PartitionId
• tpOffset :: PartitionOffset

Instances

Eq TopicPartition

Methods

(==) :: TopicPartition -> TopicPartition -> Bool

(/=) :: TopicPartition -> TopicPartition -> Bool

Show TopicPartition

Methods

showsPrec :: Int -> TopicPartition -> ShowS

show :: TopicPartition -> String

showList :: [TopicPartition] -> ShowS

data ConsumerRecord k v

Represents a received message from Kafka (i.e. used in a consumer)

Constructors

ConsumerRecord

Fields

• crTopic :: !TopicName

  Kafka topic this message was received from

• crPartition :: !PartitionId

  Kafka partition this message was received from

• crOffset :: !Offset

  Offset within the crPartition Kafka partition

• crTimestamp :: !Timestamp

  Message timestamp

• crKey :: !k
• crValue :: !v

Instances

Bifunctor ConsumerRecord

Methods

bimap :: (a -> b) -> (c -> d) -> ConsumerRecord a c -> ConsumerRecord b d

first :: (a -> b) -> ConsumerRecord a c -> ConsumerRecord b c

second :: (b -> c) -> ConsumerRecord a b -> ConsumerRecord a c

Bitraversable ConsumerRecord

Methods

bitraverse :: Applicative f => (a -> f c) -> (b -> f d) -> ConsumerRecord a b -> f (ConsumerRecord c d)

Bifoldable ConsumerRecord

Methods

bifold :: Monoid m => ConsumerRecord m m -> m

bifoldMap :: Monoid m => (a -> m) -> (b -> m) -> ConsumerRecord a b -> m

bifoldr :: (a -> c -> c) -> (b -> c -> c) -> c -> ConsumerRecord a b -> c

bifoldl :: (c -> a -> c) -> (c -> b -> c) -> c -> ConsumerRecord a b -> c

Functor (ConsumerRecord k)

Methods

fmap :: (a -> b) -> ConsumerRecord k a -> ConsumerRecord k b

(<$) :: a -> ConsumerRecord k b -> ConsumerRecord k a

Foldable (ConsumerRecord k)

Methods

fold :: Monoid m => ConsumerRecord k m -> m

foldMap :: Monoid m => (a -> m) -> ConsumerRecord k a -> m

foldr :: (a -> b -> b) -> b -> ConsumerRecord k a -> b

foldr' :: (a -> b -> b) -> b -> ConsumerRecord k a -> b

foldl :: (b -> a -> b) -> b -> ConsumerRecord k a -> b

foldl' :: (b -> a -> b) -> b -> ConsumerRecord k a -> b

foldr1 :: (a -> a -> a) -> ConsumerRecord k a -> a

foldl1 :: (a -> a -> a) -> ConsumerRecord k a -> a

toList :: ConsumerRecord k a -> [a]

null :: ConsumerRecord k a -> Bool

length :: ConsumerRecord k a -> Int

elem :: Eq a => a -> ConsumerRecord k a -> Bool

maximum :: Ord a => ConsumerRecord k a -> a

minimum :: Ord a => ConsumerRecord k a -> a

sum :: Num a => ConsumerRecord k a -> a

product :: Num a => ConsumerRecord k a -> a

Traversable (ConsumerRecord k)

Methods

traverse :: Applicative f => (a -> f b) -> ConsumerRecord k a -> f (ConsumerRecord k b)

sequenceA :: Applicative f => ConsumerRecord k (f a) -> f (ConsumerRecord k a)

mapM :: Monad m => (a -> m b) -> ConsumerRecord k a -> m (ConsumerRecord k b)

sequence :: Monad m => ConsumerRecord k (m a) -> m (ConsumerRecord k a)

(Eq v, Eq k) => Eq (ConsumerRecord k v)

Methods

(==) :: ConsumerRecord k v -> ConsumerRecord k v -> Bool

(/=) :: ConsumerRecord k v -> ConsumerRecord k v -> Bool

(Read v, Read k) => Read (ConsumerRecord k v)

Methods

readsPrec :: Int -> ReadS (ConsumerRecord k v)

readList :: ReadS [ConsumerRecord k v]

readPrec :: ReadPrec (ConsumerRecord k v)

readListPrec :: ReadPrec [ConsumerRecord k v]

(Show v, Show k) => Show (ConsumerRecord k v)

Methods

showsPrec :: Int -> ConsumerRecord k v -> ShowS

show :: ConsumerRecord k v -> String

showList :: [ConsumerRecord k v] -> ShowS

crMapKey :: (k -> k') -> ConsumerRecord k v -> ConsumerRecord k' v

crMapValue :: (v -> v') -> ConsumerRecord k v -> ConsumerRecord k v'

crMapKV :: (k -> k') -> (v -> v') -> ConsumerRecord k v -> ConsumerRecord k' v'

sequenceFirst :: (Bitraversable t, Applicative f) => t (f k) v -> f (t k v)

traverseFirst :: (Bitraversable t, Applicative f) => (k -> f k') -> t k v -> f (t k' v)

traverseFirstM :: (Bitraversable t, Applicative f, Monad m) => (k -> m (f k')) -> t k v -> m (f (t k' v))

traverseM :: (Traversable t, Applicative f, Monad m) => (v -> m (f v')) -> t v -> m (f (t v'))

bitraverseM :: (Bitraversable t, Applicative f, Monad m) => (k -> m (f k')) -> (v -> m (f v')) -> t k v -> m (f (t k' v'))