conn() = kpro:connection()
offset() = brod:offset()
partition() = brod:partition()
topic() = brod:topic()
topic_config() = kpro:struct()
vsn() = brod_kafka_apis:vsn()
create_topics/3 | Make a create_topics request. |
delete_topics/3 | Make a delete_topics request. |
fetch/7 | Make a fetch request, If the first arg is a connection pid, call
brod_kafka_apis:pick_version/2 to resolve version. |
join_group/2 | Make a join_group request. |
list_groups/1 | Make a list_groups request. |
list_offsets/4 | Make a list_offsets request message for offset resolution. |
metadata/2 | Make a metadata request. |
offset_commit/2 | Make a offset_commit request. |
offset_fetch/3 | Make a offset fetch request. |
produce/7 | Make a produce request, If the first arg is a connection pid, call
brod_kafka_apis:pick_version/2 to resolve version. |
sync_group/2 | Make a sync_group request. |
create_topics(Connection::vsn() | conn(), TopicConfigs::[topic_config()], RequestConfigs::#{timeout => kpro:int32(), validate_only => boolean()}) -> kpro:req()
Make a create_topics request.
delete_topics(Connection::vsn() | conn(), Topics::[topic()], Timeout::pos_integer()) -> kpro:req()
Make a delete_topics request.
fetch(Pid::conn(), Topic::topic(), Partition::partition(), Offset::offset(), WaitTime::kpro:wait(), MinBytes::kpro:count(), MaxBytes::kpro:count()) -> kpro:req()
Make a fetch request, If the first arg is a connection pid, call
brod_kafka_apis:pick_version/2
to resolve version.
join_group(Conn::conn(), Fields::kpro:struct()) -> kpro:req()
Make a join_group
request.
list_groups(Connection::conn()) -> kpro:req()
Make a list_groups
request.
list_offsets(Connection::conn(), Topic::topic(), Partition::partition(), TimeOrSemanticOffset::brod:offset_time()) -> kpro:req()
Make a list_offsets
request message for offset resolution.
In kafka protocol, -2 and -1 are semantic 'time' to request for
'earliest' and 'latest' offsets.
In brod implementation, -2, -1, 'earliest' and 'latest'
are semantic 'offset', this is why often a variable named
Offset is used as the Time argument.
metadata(Connection::vsn() | conn(), Topics::all | [topic()]) -> kpro:req()
Make a metadata request.
offset_commit(Conn::conn(), Fields::kpro:struct()) -> kpro:req()
Make a offset_commit
request.
offset_fetch(Connection::conn(), GroupId::brod:group_id(), Topics) -> kpro:req()
Make a offset fetch request. NOTE: empty topics list only works for kafka 0.10.2.0 or later
produce(MaybePid::conn() | vsn(), Topic::topic(), Partition::partition(), BatchInput::kpro:batch_input(), RequiredAcks::integer(), AckTimeout::integer(), Compression::brod:compression()) -> kpro:req()
Make a produce request, If the first arg is a connection pid, call
brod_kafka_apis:pick_version/2
to resolve version.
sync_group(Conn::conn(), Fields::kpro:struct()) -> kpro:req()
Make a sync_group
request.
Generated by EDoc