View Source Kayrock.Heartbeat (kayrock v0.2.0)

Kayrock-generated module for the Kafka heartbeat API

Summary

Types

request_t()

Union type for all request structs for this API

response_t()

Union type for all response structs for this API

Functions

deserialize(int, data)

Deserializes raw wire data for this API with the given version

get_request_struct(int)

Returns a request struct for this API with the given version

max_vsn()

Returns the maximum version of this API supported by Kayrock (1)

min_vsn()

Returns the minimum version of this API supported by Kayrock (0)

Types

Link to this type

request_t()

View Source 
@type request_t() ::
  Kayrock.Heartbeat.V1.Request.t() | Kayrock.Heartbeat.V0.Request.t()

Union type for all request structs for this API

Link to this type

response_t()

View Source 
@type response_t() ::
  Kayrock.Heartbeat.V1.Response.t() | Kayrock.Heartbeat.V0.Response.t()

Union type for all response structs for this API

Functions

Link to this function

deserialize(int, data)

View Source 
@spec deserialize(integer(), binary()) :: {response_t(), binary()}

Deserializes raw wire data for this API with the given version

Link to this function

get_request_struct(int)

View Source 
@spec get_request_struct(integer()) :: request_t()

Returns a request struct for this API with the given version

Link to this function

max_vsn()

View Source 
@spec max_vsn() :: integer()

Returns the maximum version of this API supported by Kayrock (1)

Link to this function

min_vsn()

View Source 
@spec min_vsn() :: integer()

Returns the minimum version of this API supported by Kayrock (0)