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

Kafka protocol Heartbeat message

Request versions summary:

  • Version 1 and version 2 are the same as version 0.
  • Starting from version 3, we add a new field called groupInstanceId to indicate member identity across restarts.
  • Version 4 is the first flexible version.

Response versions summary:

  • Version 1 adds throttle time.
  • Starting in version 2, on quota violation, brokers send out responses before throttling.
  • Starting from version 3, heartbeatRequest supports a new field called groupInstanceId to indicate member identity across restarts.
  • Version 4 is the first flexible version.

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

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

  • generation_id: The generation of the group. (int32 | versions 0+)

  • member_id: The member ID. (string | versions 0+)

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