View Source kpro_sent_reqs (kafka_protocol v4.1.9)

This module manages an opaque collection of sent-requests.

Summary

Types

corr_id/0
requests/0

Functions

add(Requests, Caller, Ref, API, Vsn)
Add a new request to sent collection. Return the last corrlation ID and the new collection.
del(Requests, CorrId)
Delete a request from the opaque collection. Crash if correlation ID is not found.
get_corr_id(Requests)
Get the correction to be sent for the next request.
get_req(Requests, CorrId)
Get caller of a request having the given correlation ID. Crash if the request is not found.
increment_corr_id(Requests)
Fetch and increment the correlation ID This is used if we don't want a response from the broker
is_empty(Requests)
new()
scan_for_max_age(Requests)
Scan all sent requests to get oldest sent request. Age is in milli-seconds. 0 is returned if there is no pending response.

Types

Link to this type

corr_id/0

View Source 
-type corr_id() :: kpro:corr_id().
Link to this opaque

requests/0

View Source 
-opaque requests()

Functions

Link to this function

add(Requests, Caller, Ref, API, Vsn)

View Source 
-spec add(requests(), pid(), reference(), kpro:api(), kpro:vsn()) -> {corr_id(), requests()}.
Add a new request to sent collection. Return the last corrlation ID and the new collection.
Link to this function

del(Requests, CorrId)

View Source 
-spec del(requests(), corr_id()) -> requests().
Delete a request from the opaque collection. Crash if correlation ID is not found.
Link to this function

get_corr_id(Requests)

View Source 
-spec get_corr_id(requests()) -> corr_id().
Get the correction to be sent for the next request.
Link to this function

get_req(Requests, CorrId)

View Source 
-spec get_req(requests(), corr_id()) -> {pid(), reference(), kpro:api(), kpro:vsn()}.
Get caller of a request having the given correlation ID. Crash if the request is not found.
Link to this function

increment_corr_id(Requests)

View Source 
-spec increment_corr_id(requests()) -> {corr_id(), requests()}.
Fetch and increment the correlation ID This is used if we don't want a response from the broker
Link to this function

is_empty(Requests)

View Source 
-spec is_empty(requests()) -> boolean().
Link to this function

new()

View Source 
-spec new() -> requests().
Link to this function

scan_for_max_age(Requests)

View Source 
-spec scan_for_max_age(requests()) -> timeout().
Scan all sent requests to get oldest sent request. Age is in milli-seconds. 0 is returned if there is no pending response.