Safe Haskell | None |
---|---|
Language | Haskell2010 |
Kafka.Types
Description
Module holding types shared by consumer and producer modules.
Synopsis
- newtype BrokerId = BrokerId {
- unBrokerId :: Int
- newtype PartitionId = PartitionId {
- unPartitionId :: Int
- newtype Millis = Millis {}
- newtype ClientId = ClientId {
- unClientId :: Text
- newtype BatchSize = BatchSize {
- unBatchSize :: Int
- newtype TopicName = TopicName {
- unTopicName :: Text
- newtype BrokerAddress = BrokerAddress {}
- newtype Timeout = Timeout {}
- data KafkaLogLevel
- data KafkaError
- data KafkaDebug
- data KafkaCompressionCodec
- = NoCompression
- | Gzip
- | Snappy
- | Lz4
- data TopicType
- topicType :: TopicName -> TopicType
- kafkaDebugToText :: KafkaDebug -> Text
- kafkaCompressionCodecToText :: KafkaCompressionCodec -> Text
Documentation
Kafka broker ID
Constructors
BrokerId | |
Fields
|
newtype PartitionId Source #
Topic partition ID
Constructors
PartitionId | |
Fields
|
Instances
A number of milliseconds, used to represent durations and timestamps
Client ID used by Kafka to better track requests
Constructors
ClientId | |
Fields
|
Batch size used for polling
Constructors
BatchSize | |
Fields
|
Instances
Eq BatchSize Source # | |
Num BatchSize Source # | |
Ord BatchSize Source # | |
Read BatchSize Source # | |
Show BatchSize Source # | |
Generic BatchSize Source # | |
type Rep BatchSize Source # | |
Defined in Kafka.Types |
Topic name to consume/produce messages
Wildcard (regex) topics are supported by the librdkafka assignor:
any topic name in the topics list that is prefixed with ^
will
be regex-matched to the full list of topics in the cluster and matching
topics will be added to the subscription list.
Constructors
TopicName | |
Fields
|
Instances
Eq TopicName Source # | |
Ord TopicName Source # | |
Read TopicName Source # | |
Show TopicName Source # | |
IsString TopicName Source # | |
Defined in Kafka.Types Methods fromString :: String -> TopicName # | |
Generic TopicName Source # | |
type Rep TopicName Source # | |
Defined in Kafka.Types |
newtype BrokerAddress Source #
Kafka broker address string (e.g. broker1:9092
)
Constructors
BrokerAddress | |
Fields |
Instances
Eq BrokerAddress Source # | |
Defined in Kafka.Types Methods (==) :: BrokerAddress -> BrokerAddress -> Bool # (/=) :: BrokerAddress -> BrokerAddress -> Bool # | |
Show BrokerAddress Source # | |
Defined in Kafka.Types Methods showsPrec :: Int -> BrokerAddress -> ShowS # show :: BrokerAddress -> String # showList :: [BrokerAddress] -> ShowS # | |
IsString BrokerAddress Source # | |
Defined in Kafka.Types Methods fromString :: String -> BrokerAddress # | |
Generic BrokerAddress Source # | |
Defined in Kafka.Types Associated Types type Rep BrokerAddress :: Type -> Type # | |
type Rep BrokerAddress Source # | |
Defined in Kafka.Types type Rep BrokerAddress = D1 (MetaData "BrokerAddress" "Kafka.Types" "hw-kafka-client-4.0.2-inplace" True) (C1 (MetaCons "BrokerAddress" PrefixI True) (S1 (MetaSel (Just "unBrokerAddress") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) |
Timeout in milliseconds
data KafkaLogLevel Source #
Log levels for librdkafka.
Constructors
KafkaLogEmerg | |
KafkaLogAlert | |
KafkaLogCrit | |
KafkaLogErr | |
KafkaLogWarning | |
KafkaLogNotice | |
KafkaLogInfo | |
KafkaLogDebug |
Instances
Enum KafkaLogLevel Source # | |
Defined in Kafka.Types Methods succ :: KafkaLogLevel -> KafkaLogLevel # pred :: KafkaLogLevel -> KafkaLogLevel # toEnum :: Int -> KafkaLogLevel # fromEnum :: KafkaLogLevel -> Int # enumFrom :: KafkaLogLevel -> [KafkaLogLevel] # enumFromThen :: KafkaLogLevel -> KafkaLogLevel -> [KafkaLogLevel] # enumFromTo :: KafkaLogLevel -> KafkaLogLevel -> [KafkaLogLevel] # enumFromThenTo :: KafkaLogLevel -> KafkaLogLevel -> KafkaLogLevel -> [KafkaLogLevel] # | |
Eq KafkaLogLevel Source # | |
Defined in Kafka.Types Methods (==) :: KafkaLogLevel -> KafkaLogLevel -> Bool # (/=) :: KafkaLogLevel -> KafkaLogLevel -> Bool # | |
Show KafkaLogLevel Source # | |
Defined in Kafka.Types Methods showsPrec :: Int -> KafkaLogLevel -> ShowS # show :: KafkaLogLevel -> String # showList :: [KafkaLogLevel] -> ShowS # |
data KafkaError Source #
All possible Kafka errors
Constructors
KafkaError Text | |
KafkaInvalidReturnValue | |
KafkaBadSpecification Text | |
KafkaResponseError RdKafkaRespErrT | |
KafkaInvalidConfigurationValue Text | |
KafkaUnknownConfigurationKey Text | |
KafkaBadConfiguration |
Instances
data KafkaDebug Source #
Available librdkafka debug contexts
Constructors
DebugGeneric | |
DebugBroker | |
DebugTopic | |
DebugMetadata | |
DebugQueue | |
DebugMsg | |
DebugProtocol | |
DebugCgrp | |
DebugSecurity | |
DebugFetch | |
DebugFeature | |
DebugAll |
Instances
data KafkaCompressionCodec Source #
Compression codec used by a topic
Constructors
NoCompression | |
Gzip | |
Snappy | |
Lz4 |
Instances
Whether the topic is created by a user or by the system
Constructors
User | Normal topics that are created by user. |
System | Topics starting with a double underscore "__" ( |
Instances
Eq TopicType Source # | |
Ord TopicType Source # | |
Read TopicType Source # | |
Show TopicType Source # | |
Generic TopicType Source # | |
type Rep TopicType Source # | |
topicType :: TopicName -> TopicType Source #
Deduce the type of a topic from its name, by checking if it starts with a double underscore "__"
kafkaDebugToText :: KafkaDebug -> Text Source #
Convert a KafkaDebug
into its librdkafka string equivalent.
This is used internally by the library but may be useful to some developers.
kafkaCompressionCodecToText :: KafkaCompressionCodec -> Text Source #
Convert a KafkaCompressionCodec
into its librdkafka string equivalent.
This is used internally by the library but may be useful to some developers.