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

Kafka protocol Envelope message

Request versions summary:

  • Request struct for forwarding.

Response versions summary:

  • Response struct for forwarding.

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:

  • response_data: The embedded response header and data. (bytes | 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:

  • request_data: The embedded request header and data. (bytes | versions 0+)

  • request_principal: Value of the initial client principal when the request is redirected by a broker. (bytes | versions 0+)

  • client_host_address: The original client's address in bytes. (bytes | versions 0+)