Consumer

public class Consumer

A client that consumes records from a Kafka cluster. This client transparently handles the failure of Kafka brokers, and transparently adapts as topic partitions it fetches migrate within the cluster. This client also interacts with the broker to allow groups of consumers to load balance consumption using consumer groups.

The consumer maintains TCP connections to the necessary brokers to fetch data.

General

The consumer will transparently handle the failure of servers in the Kafka cluster, and adapt as topic-partitions are created or migrate between brokers. It also interacts with the assigned kafka Group Coordinator node to allow multiple consumers to load balance consumption of topics.

Consumer Groups and Subscriptions

Kafka maintains an offset for each record in a partition.

configuration
Undocumented
Declaration
Swift

public let configuration: Configuration


                    
                    
                    connect(configuration:eventLoopGroup:logger:)

Connect to the cluster

Declaration

Swift

static public func connect(configuration: Configuration,
                           eventLoopGroup: EventLoopGroup,
                           logger: Logger = Logger(label: "io.bartelmess.KafkaNIO")) throws -> EventLoopFuture<Consumer>


                    
                    
                    updateOffets(recordBatch:)

Undocumented

Declaration

Swift

public func updateOffets(recordBatch: RecordBatch) throws


                    
                    
                    updateOffsets(recordBatches:)

Undocumented

Declaration

Swift

public func updateOffsets(recordBatches: [RecordBatch]) throws


                    
                    
                    poll(configuration:)

Undocumented

Declaration

Swift

public func poll(configuration: Consumer.FetchConfiguration = .default) -> EventLoopFuture<[RecordBatch]>


                    
                    
                    setup()

Undocumented

Declaration

Swift

public func setup() -> EventLoopFuture<Void>

shutdown()
Shuts down the consumer, returning an event loop future when consuming stopped. When the consumer is not in the .consuming state, the event loop future will fail with ProtocolError.invalidState
Declaration
Swift

public func shutdown() -> EventLoopFuture<Void>
Configuration
Consumer configuration.
See more
Declaration
Swift

public struct Configuration
FetchConfiguration
Undocumented
See more
Declaration
Swift

public struct FetchConfiguration