View Source KafkaEx.Messages.JoinGroup (kafka_ex v1.0.0-rc.1)

This module represents JoinGroup response from Kafka.

The response includes the generation ID, protocol, leader, member ID, and the list of all group members for leader assignment.

Summary

Types

t()

Functions

build(opts \\ [])

Builds a JoinGroup struct from response data.

leader?(join_group)

Returns true if the member is the group leader.

Types

t()

@type t() :: %KafkaEx.Messages.JoinGroup{
  generation_id: non_neg_integer(),
  group_protocol: binary(),
  leader_id: binary(),
  member_id: binary(),
  members: [KafkaEx.Messages.JoinGroup.Member.t()],
  throttle_time_ms: nil | non_neg_integer()
}

Functions

build(opts \\ [])

@spec build(Keyword.t()) :: t()

Builds a JoinGroup struct from response data.

leader?(join_group)

@spec leader?(t()) :: boolean()

Returns true if the member is the group leader.