Klife Protocol
v0.5.0

View Source KlifeProtocol.Messages.LeaveGroup (Klife Protocol v0.5.0)

Kafka protocol LeaveGroup message

Request versions summary:

  • Version 1 and 2 are the same as version 0.
  • Version 3 defines batch processing scheme with group.instance.id + member.id for identity
  • Version 4 is the first flexible version.
  • Version 5 adds the Reason field (KIP-800).

Response versions summary:

  • Version 1 adds the throttle time.
  • Starting in version 2, on quota violation, brokers send out responses before throttling.
  • Starting in version 3, we will make leave group request into batch mode and add group.instance.id.
  • Version 4 is the first flexible version.
  • Version 5 is the same as version 4.

Link to this section Summary

Functions

api_key()

Returns the message api key number.

deserialize_response(data, version, with_header? \\ true)

Receive a binary in the kafka wire format and deserialize it into a map.

max_supported_version()

Returns the current max supported version of this message.

min_supported_version()

Returns the current min supported version of this message.

serialize_request(map, version)

Receives a map and serialize it to kafka wire format of the given version.

Link to this section Functions

Link to this function

api_key()

View Source

Returns the message api key number.

Link to this function

deserialize_response(data, version, with_header? \\ true)

View Source

Receive a binary in the kafka wire format and deserialize it into a map.

Response content fields:

  • throttle_time_ms: The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota. (int32 | versions 1+)

  • error_code: The error code, or 0 if there was no error. (int16 | versions 0+)

  • members: List of leaving member responses. ([]MemberResponse | versions 3+)

    • member_id: The member ID to remove from the group. (string | versions 3+)

    • group_instance_id: The group instance ID to remove from the group. (string | versions 3+)

    • error_code: The error code, or 0 if there was no error. (int16 | versions 3+)

Link to this function

max_supported_version()

View Source

Returns the current max supported version of this message.

Link to this function

min_supported_version()

View Source

Returns the current min supported version of this message.

Link to this function

serialize_request(map, version)

View Source

Receives a map and serialize it to kafka wire format of the given version.

Input content fields:

  • group_id: The ID of the group to leave. (string | versions 0+)

  • member_id: The member ID to remove from the group. (string | versions 0-2)

  • members: List of leaving member identities. ([]MemberIdentity | versions 3+)

    • member_id: The member ID to remove from the group. (string | versions 3+)

    • group_instance_id: The group instance ID to remove from the group. (string | versions 3+)

    • reason: The reason why the member left the group. (string | versions 5+)