View Source KlifeProtocol.Messages.OffsetCommit (Klife Protocol v0.7.0)

Kafka protocol OffsetCommit message

Request versions summary:

  • Version 1 adds timestamp and group membership information, as well as the commit timestamp.
  • Version 2 adds retention time. It removes the commit timestamp added in version 1.
  • Version 3 and 4 are the same as version 2.
  • Version 5 removes the retention time, which is now controlled only by a broker configuration.
  • Version 6 adds the leader epoch for fencing.
  • version 7 adds a new field called groupInstanceId to indicate member identity across restarts.
  • Version 8 is the first flexible version.
  • Version 9 is the first version that can be used with the new consumer group protocol (KIP-848). The request is the same as version 8.

Response versions summary:

  • Versions 1 and 2 are the same as version 0.
  • Version 3 adds the throttle time to the response.
  • Starting in version 4, on quota violation, brokers send out responses before throttling.
  • Versions 5 and 6 are the same as version 4.
  • Version 7 offsetCommitRequest supports a new field called groupInstanceId to indicate member identity across restarts.
  • Version 8 is the first flexible version.
  • Version 9 is the first version that can be used with the new consumer group protocol (KIP-848). The response is the same as version 8 but can return STALE_MEMBER_EPOCH when the new consumer group protocol is used and GROUP_ID_NOT_FOUND when the group does not exist for both protocols.

Link to this section Summary

Functions

Returns the message api key number.

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

Returns the current max supported version of this message.

Returns the current min supported version of this message.

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

Link to this section Functions

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 3+)

  • topics: The responses for each topic. ([]OffsetCommitResponseTopic | versions 0+)

    • name: The topic name. (string | versions 0+)

    • partitions: The responses for each partition in the topic. ([]OffsetCommitResponsePartition | versions 0+)

      • partition_index: The partition index. (int32 | versions 0+)

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

Returns the current max supported version of this message.

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 unique group identifier. (string | versions 0+)

  • generation_id_or_member_epoch: The generation of the group if using the classic group protocol or the member epoch if using the consumer protocol. (int32 | versions 1+)

  • member_id: The member ID assigned by the group coordinator. (string | versions 1+)

  • group_instance_id: The unique identifier of the consumer instance provided by end user. (string | versions 7+)

  • retention_time_ms: The time period in ms to retain the offset. (int64 | versions 2-4)

  • topics: The topics to commit offsets for. ([]OffsetCommitRequestTopic | versions 0+)

    • name: The topic name. (string | versions 0+)

    • partitions: Each partition to commit offsets for. ([]OffsetCommitRequestPartition | versions 0+)

      • partition_index: The partition index. (int32 | versions 0+)

      • committed_offset: The message offset to be committed. (int64 | versions 0+)

      • committed_leader_epoch: The leader epoch of this partition. (int32 | versions 6+)

      • commit_timestamp: The timestamp of the commit. (int64 | versions 1)

      • committed_metadata: Any associated metadata the client wants to keep. (string | versions 0+)