Overview

Module kpro_req_lib

• Data Types
• Function Index
• Function Details

Data Types

api()

api() = kpro:api()

batch_input()

batch_input() = kpro:batch_input()

client_id()

client_id() = kpro:client_id()

corr_id()

corr_id() = kpro:corr_id()

count()

count() = kpro:count()

fetch_opts()

fetch_opts() = #{max_wait_time => wait(), min_bytes => count(), max_bytes => count(), isolation_level => isolation_level(), session_id => kpro:int32(), session_epoch => kpro:int32(), rack_id => iodata()}

Options for a fetch request.

• max_wait_time: The maximum time (in millis) to block wait until there are enough messages that have in sum at least min_bytes bytes. The waiting will end as soon as either min_bytes is satisfied or max_wait_time is exceeded, whichever comes first. Defaults to 1 second.
• min_bytes: The minimum size of the message set. If it there are not enough messages, Kafka will block wait (but at most for max_wait_time). This implies that the response may be actually smaller in case the time runs out. If you set it to 0, Kafka will respond immediately (possibly with an empty message set). You can use this option together with max_wait_time to configure throughput, latency, and size of message sets. Defaults to 0.
• max_bytes: The maximum size of the message set. Note that this is not an absolute maximum, if the first message in the message set is larger than this value, the message will still be returned to ensure that progress can be made. Defaults to 1 MB.
• isolation_level: This setting controls the visibility of transactional records. Using read_uncommitted makes all records visible. With read_committed, non-transactional and committed transactional records are visible. To be more concrete, read_committed returns all data from offsets smaller than the current LSO (last stable offset), and enables the inclusion of the list of aborted transactions in the result, which allows consumers to discard aborted transactional records. Defaults to read_committed.
• session_id: Fetch session ID. This can be useful when the fetch request spans over multiple topic-partitions. However, fetch requests in kpro can span only over a single topic-partition and so kpro by default does not use fetch sessions (by setting appropriate session_id and session_epoch default values). Defaults to 0.
• session_epoch: Fetch session epoch. Holds the same as above. Defaults to -1.
• rack_id: The consumer's rack ID. This allow consumers fetching from closest replica (instead the leader). Defaults to undefined.

group_id()

group_id() = kpro:group_id()

isolation_level()

isolation_level() = kpro:isolation_level()

msg_ts()

msg_ts() = kpro:msg_ts()

offset()

offset() = kpro:offset()

offsets_to_commit()

offsets_to_commit() = kpro:offsets_to_commit()

partition()

partition() = kpro:partition()

produce_opts()

produce_opts() = kpro:produce_opts()

req()

req() = kpro:req()

struct()

struct() = kpro:struct()

topic()

topic() = kpro:topic()

txn_ctx()

txn_ctx() = kpro:txn_ctx()

vsn()

vsn() = kpro:vsn()

wait()

wait() = kpro:wait()

Function Index

Function Details

add_offsets_to_txn/2

Make add_offsets_to_txn request.

add_partitions_to_txn/2

Make add_partitions_to_txn request.

alter_configs/3

Make an alter_configs request.

create_partitions/3

Make a create_partitions request.

create_topics/3

Make create_topics request. if 0 is given as timeout option the request will trigger a creation but return immediately. validate_only option is only relevant when the API version is greater than 0.

delete_topics/3

Make delete_topics request.

describe_configs/3

Make a describe_configs request. include_synonyms option is only relevant when the API version is greater than 0.

encode/3

Encode a request to bytes that can be sent on wire.

end_txn/2

Make end_txn request.

fetch/5

Help function to construct a fetch request against one single topic-partition. In transactional mode, set IsolationLevel = kpro_read_uncommitted to fetch uncommitted messages.

list_offsets/4

Help function to construct a list_offset request against one single topic-partition.

list_offsets/5

Help function to construct a list_offset request against one single topic-partition. In transactional mode, set IsolationLevel = ?kpro_read_uncommitted to list uncommitted offsets.

list_offsets/6

Extends list_offsets/5 with leader-epoch number which can be obtained from metadata response for each partition.

make/3

Help function to make a request body.

metadata/2

Make a metadata request

metadata/3

Make a metadata request

produce/4

Help function to construct a produce request.

produce/5

Help function to construct a produce request. By default, it constructs a non-transactional produce request. For transactional produce requests, below conditions should be met. 1. Batch arg must be be a [map()] to indicate magic v2, for example: [#{key => Key, value => Value, ts => Ts}]. Current system time will be taken if ts is missing in batch input. It may also be binary() if user choose to encode a batch beforehand. This could be helpful when a large batch can be encoded in another process, so it may pass large binary instead of list between processes. 2. first_sequence must exist in Opts. It should be the sequence number for the fist message in batch. Maintained by producer, sequence numbers should start from zero and be monotonically increasing, with one sequence number per topic-partition. 3. txn_ctx (which is of spec kpro:txn_ctx()) must exist in Opts

txn_offset_commit/4

Make a txn_offset_commit request.

Overview

Generated by EDoc