Pool of transactional producers.

Client configurations

• :delivery_timeout_ms (non_neg_integer/0) - The maximum amount of time the producer will retry to deliver a message before timing out and failing the send. The default value is 60000.

• :request_timeout_ms (non_neg_integer/0) - The maximum amount of time the producer will wait for a broker response to a request before considering it as failed. The default value is 15000.

• :retry_backoff_ms (non_neg_integer/0) - The amount of time that the producer waits before retrying a failed request to the broker. The default value is 1000.

• :compression_type (:none, :gzip or :snappy) - The compression algorithm to be used for compressing messages before they are sent to the broker. The default value is :none.

• :name (atom/0) - Required. Pool name. Can be used as an option on the transactional api

• :base_txn_id (String.t/0) - Prefix used to define the transactional_id for the transactional producers. If not provided, a random string will be used. The default value is "".

• :pool_size (non_neg_integer/0) - Number of transactional producers in the pool The default value is 20.

• :txn_timeout_ms (non_neg_integer/0) - The maximum amount of time, in milliseconds, that a transactional producer is allowed to remain open without either committing or aborting a transaction before it is considered expired The default value is 90000.

How to use?

When configuring Klife.Client, users can specify a list of transactional pools to be initialized for sending records to the Kafka cluster.

Once configured, users can interact with these transactional producers through the Klife.Client transaction API.

Basic understanding

Since a single producer can only have a single open transaction at any given time Klife starts a pool of transactional producers that can be checked out by other processes in order to execute transactions.

Each transactional producer is a standard Klife.Producer but with transactional capabilities. The transactional behaviour can be tweaked using its specific configurations.

Semantics

A more practical and guided discussion about transaction semantics can be found on Klife.Client transaction API.