# DO NOT EDIT THIS FILE MANUALLY
# This module is automatically generated by running mix task generate_file
# every change must be done inside the mix task directly
defmodule KlifeProtocol.Messages.ControlledShutdown do
@moduledoc """
Kafka protocol ControlledShutdown message
Request versions summary:
- Version 0 of ControlledShutdownRequest has a non-standard request header
which does not include clientId. Version 1 and later use the standard
request header.
- Version 1 is the same as version 0.
- Version 2 adds BrokerEpoch.
Response versions summary:
- Versions 1 and 2 are the same as version 0.
"""
alias KlifeProtocol.Deserializer
alias KlifeProtocol.Serializer
alias KlifeProtocol.Header
@api_key 7
@min_flexible_version_req 3
@min_flexible_version_res 3
@doc """
Receives a map and serialize it to kafka wire format of the given version.
Input content fields:
- broker_id: The id of the broker for which controlled shutdown has been requested. (int32 | versions 0+)
- broker_epoch: The broker epoch. (int64 | versions 2+)
"""
def serialize_request(%{headers: headers, content: content}, version) do
headers
|> Map.put(:request_api_key, @api_key)
|> Map.put(:request_api_version, version)
|> Header.serialize_request(req_header_version(version))
|> then(&Serializer.execute(content, request_schema(version), &1))
end
@doc """
Receive a binary in the kafka wire format and deserialize it into a map.
Response content fields:
- error_code: The top-level error code. (int16 | versions 0+)
- remaining_partitions: The partitions that the broker still leads. ([]RemainingPartition | versions 0+)
- topic_name: The name of the topic. (string | versions 0+)
- partition_index: The index of the partition. (int32 | versions 0+)
"""
def deserialize_response(data, version, with_header? \\ true)
def deserialize_response(data, version, true) do
{:ok, {headers, rest_data}} = Header.deserialize_response(data, res_header_version(version))
case Deserializer.execute(rest_data, response_schema(version)) do
{:ok, {content, <<>>}} ->
{:ok, %{headers: headers, content: content}}
{:error, _reason} = err ->
err
end
end
def deserialize_response(data, version, false) do
case Deserializer.execute(data, response_schema(version)) do
{:ok, {content, <<>>}} ->
{:ok, %{content: content}}
{:error, _reason} = err ->
err
end
end
@doc """
Returns the message api key number.
"""
def api_key(), do: @api_key
@doc """
Returns the current max supported version of this message.
"""
def max_supported_version(), do: 3
@doc """
Returns the current min supported version of this message.
"""
def min_supported_version(), do: 0
defp req_header_version(msg_version) do
if msg_version in [0],
do: 0,
else: if(msg_version >= @min_flexible_version_req, do: 2, else: 1)
end
defp res_header_version(msg_version),
do: if(msg_version >= @min_flexible_version_res, do: 1, else: 0)
defp request_schema(0), do: [broker_id: {:int32, %{is_nullable?: false}}]
defp request_schema(1), do: [broker_id: {:int32, %{is_nullable?: false}}]
defp request_schema(2),
do: [
broker_id: {:int32, %{is_nullable?: false}},
broker_epoch: {:int64, %{is_nullable?: false}}
]
defp request_schema(3),
do: [
broker_id: {:int32, %{is_nullable?: false}},
broker_epoch: {:int64, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, []}
]
defp request_schema(unkown_version),
do: raise("Unknown version #{unkown_version} for message ControlledShutdown")
defp response_schema(0),
do: [
error_code: {:int16, %{is_nullable?: false}},
remaining_partitions:
{{:array,
[
topic_name: {:string, %{is_nullable?: false}},
partition_index: {:int32, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(1),
do: [
error_code: {:int16, %{is_nullable?: false}},
remaining_partitions:
{{:array,
[
topic_name: {:string, %{is_nullable?: false}},
partition_index: {:int32, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(2),
do: [
error_code: {:int16, %{is_nullable?: false}},
remaining_partitions:
{{:array,
[
topic_name: {:string, %{is_nullable?: false}},
partition_index: {:int32, %{is_nullable?: false}}
]}, %{is_nullable?: false}}
]
defp response_schema(3),
do: [
error_code: {:int16, %{is_nullable?: false}},
remaining_partitions:
{{:compact_array,
[
topic_name: {:compact_string, %{is_nullable?: false}},
partition_index: {:int32, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]}, %{is_nullable?: false}},
tag_buffer: {:tag_buffer, %{}}
]
defp response_schema(unkown_version),
do: raise("Unknown version #{unkown_version} for message ControlledShutdown")
end