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

Kafka protocol OffsetForLeaderEpoch message

Request versions summary:

  • Version 1 is the same as version 0.
  • Version 2 adds the current leader epoch to support fencing.
  • Version 3 adds ReplicaId (the default is -2 which conventionally represents a "debug" consumer which is allowed to see offsets beyond the high watermark). Followers will use this replicaId when using an older version of the protocol.
  • Version 4 enables flexible versions.

Response versions summary:

  • Version 1 added the leader epoch to the response.
  • Version 2 added the throttle time.
  • Version 3 is the same as version 2.
  • Version 4 enables flexible versions.

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

  • topics: Each topic we fetched offsets for. ([]OffsetForLeaderTopicResult | versions 0+)

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

    • partitions: Each partition in the topic we fetched offsets for. ([]EpochEndOffset | versions 0+)

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

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

      • leader_epoch: The leader epoch of the partition. (int32 | versions 1+)

      • end_offset: The end offset of the epoch. (int64 | 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:

  • replica_id: The broker ID of the follower, of -1 if this request is from a consumer. (int32 | versions 3+)

  • topics: Each topic to get offsets for. ([]OffsetForLeaderTopic | versions 0+)

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

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

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

      • current_leader_epoch: An epoch used to fence consumers/replicas with old metadata. If the epoch provided by the client is larger than the current epoch known to the broker, then the UNKNOWN_LEADER_EPOCH error code will be returned. If the provided epoch is smaller, then the FENCED_LEADER_EPOCH error code will be returned. (int32 | versions 2+)

      • leader_epoch: The epoch to look up an offset for. (int32 | versions 0+)