haskakafka-1.0.0: Kafka bindings for Haskell

Safe HaskellNone

Haskakafka.InternalTypes

Synopsis

Documentation

data KafkaConf Source

Kafka configuration object

data KafkaTopicConf Source

Kafka topic configuration object

data Kafka Source

Main pointer to Kafka object, which contains our brokers

Constructors

Kafka 

data KafkaTopic Source

Main pointer to Kafka topic, which is what we consume from or produce to

data KafkaOffset Source

Starting locations for a consumer

Constructors

KafkaOffsetBeginning

Start reading from the beginning of the partition

KafkaOffsetEnd

Start reading from the end

KafkaOffset Int64

Start reading from a specific location within the partition

KafkaOffsetStored

Start reading from the stored offset. See librdkafka's documentation for offset store configuration.

data KafkaMessage Source

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

Constructors

KafkaMessage 

Fields

messagePartition :: !Int

Kafka partition this message was received from

messageOffset :: !Int64

Offset within the messagePartition Kafka partition

messagePayload :: !ByteString

Contents of the message, as a ByteString

messageKey :: Maybe ByteString

Optional key of the message. Nothing when the message was enqueued without a key

Instances

data KafkaProduceMessage Source

Represents messages to be enqueued onto a Kafka broker (i.e. used for a producer)

Constructors

KafkaProduceMessage !ByteString

A message without a key, assigned to KafkaSpecifiedPartition or KafkaUnassignedPartition

KafkaProduceKeyedMessage !ByteString !ByteString

A message with a key, assigned to a partition based on the key

data KafkaProducePartition Source

Options for destination partition when enqueuing a message

Constructors

KafkaSpecifiedPartition !Int

A specific partition in the topic

KafkaUnassignedPartition

A random partition within the topic

data KafkaMetadata Source

Metadata for all Kafka brokers

Constructors

KafkaMetadata 

Fields

brokers :: [KafkaBrokerMetadata]

Broker metadata

topics :: [Either KafkaError KafkaTopicMetadata]

topic metadata

Instances

data KafkaBrokerMetadata Source

Metadata for a specific Kafka broker

Constructors

KafkaBrokerMetadata 

Fields

brokerId :: Int

broker identifier

brokerHost :: String

hostname for the broker

brokerPort :: Int

port for the broker

data KafkaTopicMetadata Source

Metadata for a specific topic

Constructors

KafkaTopicMetadata 

Fields

topicName :: String

name of the topic

topicPartitions :: [Either KafkaError KafkaPartitionMetadata]

partition metadata

data KafkaPartitionMetadata Source

Metadata for a specific partition

Constructors

KafkaPartitionMetadata 

Fields

partitionId :: Int

identifier for the partition

partitionLeader :: Int

broker leading this partition

partitionReplicas :: [Int]

replicas of the leader

partitionIsrs :: [Int]

In-sync replica set, see http://kafka.apache.org/documentation.html

data KafkaLogLevel Source

Log levels for the RdKafkaLibrary used in setKafkaLogLevel

Instances