local

Overview ¶

Package local contains a local file-based implementation of kafka.Client.

Normally, outside lib/kafka, you shouldn't import this package directly. Most applications should use DefaultClient from lib/kafka to decide automatically which client to use.

Package local is a local file-based implementation of kafka.Client. It stores data in append-only topic files a local directory. Several instances of local.Kafka communicate correctly via this directory even across process boundaries.

The purpose is to eliminate the memory footprint and hassle of running real Kafka for local testing such as in a box environment.

The implementation is not perfectly reliable: it can theoretically leave a topic file corrupted if a write succeeds partially. However, this is highly unlikely, so the implementation is good enough for local testing.