Backplane.AiProtocol.Wire (backplane_ai_protocol v0.7.0)

Copy Markdown

Pure Backplane WebSocket V1 admission, correlation, sequencing, and credit contract.

Unknown or terminal request IDs are rejected without allocating state. At the lifetime ID limit the connection enters draining state: active requests may terminate, but no new request is admitted.

Summary

Types

t()

Functions

accept_request(state, request_id)
active_ids(wire)
command_response(attrs)
credit(state, request_id)
grant_credit(state, request_id, amount)
handshake(state, welcome_attrs)
hello(attrs)
new()
retire?(wire)
seen_ids(wire)
send_data(state, attrs)
terminal(state, attrs)
welcome(attrs)

Types

t()

@type t() :: %Backplane.AiProtocol.Wire{
  active: term(),
  credits: term(),
  draining?: term(),
  handshake?: term(),
  limits: term(),
  max_seen_ids: term(),
  seen_ids: term()
}

Functions

accept_request(state, request_id)

@spec accept_request(t(), String.t()) ::
  {:ok, t()}
  | {:error, Backplane.AiProtocol.Error.t()}
  | {:error, Backplane.AiProtocol.Error.t(), t()}

active_ids(wire)

command_response(attrs)

@spec command_response(map()) :: map()

credit(state, request_id)

grant_credit(state, request_id, amount)

@spec grant_credit(t(), String.t(), non_neg_integer()) ::
  {:ok, t()} | {:error, Backplane.AiProtocol.Error.t()}

handshake(state, welcome_attrs)

@spec handshake(t(), map()) :: {:ok, t()} | {:error, Backplane.AiProtocol.Error.t()}

hello(attrs)

@spec hello(map()) :: {:ok, map()} | {:error, Backplane.AiProtocol.Error.t()}

new()

@spec new() :: t()

retire?(wire)

seen_ids(wire)

send_data(state, attrs)

@spec send_data(t(), map()) ::
  {:ok, t(), map()} | {:error, Backplane.AiProtocol.Error.t()}

terminal(state, attrs)

@spec terminal(t(), map()) ::
  {:ok, t(), map()} | {:error, Backplane.AiProtocol.Error.t()}

welcome(attrs)

@spec welcome(map()) :: {:ok, map()} | {:error, Backplane.AiProtocol.Error.t()}