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

Kafka protocol BrokerHeartbeat message

Request versions summary:

Response versions summary:

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: 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 0+)

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

  • is_caught_up: True if the broker has approximately caught up with the latest metadata. (bool | versions 0+)

  • is_fenced: True if the broker is fenced. (bool | versions 0+)

  • should_shut_down: True if the broker should proceed with its shutdown. (bool | 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:

  • broker_id: The broker ID. (int32 | versions 0+)

  • broker_epoch: The broker epoch. (int64 | versions 0+)

  • current_metadata_offset: The highest metadata offset which the broker has reached. (int64 | versions 0+)

  • want_fence: True if the broker wants to be fenced, false otherwise. (bool | versions 0+)

  • want_shut_down: True if the broker wants to be shut down, false otherwise. (bool | versions 0+)

  • offline_log_dirs: Log directories that failed and went offline. ([]uuid | versions 1+)