Quic.LocalCIDs (elixir_quic v1.0.0-rc.9)

Bounded local connection-ID issuance, registration, and retirement.

The caller supplies CID material and a registration identity scoped to its connection generation. Registration acknowledgment makes an issuance ready; only publication after a successful local send advances the sent watermark. Retired entries are removed rather than retained as connection history.

Summary

Types

entry()

frame()

pending()

registration()

t()

Functions

active?(state, cid)

configure(state, peer_limit)

new(initial, peer_limit \\ 2)

published(state, sequence)

Commit first transmission after successful registration and local send.

refill?(state)

Whether one refill can be reserved without duplicating pending work.

registered(state, identity)

Acknowledge the exact route registration and return its ready frame.

reserve(state, cid, token, registration_id)

Reserve one route registration; this does not authorize advertisement.

retire(state, sequence, containing_dcid)

Retire once, returning the route to remove without retaining its token.

Types

entry()

@type entry() :: %{cid: binary(), token: binary() | nil}

frame()

@type frame() :: %{
  type: :new_connection_id,
  sequence: non_neg_integer(),
  retire_prior_to: 0,
  cid: binary(),
  token: binary()
}

pending()

@type pending() :: %{
  sequence: non_neg_integer(),
  cid: binary(),
  token: binary(),
  registration_id: term(),
  status: :registering | :ready
}

registration()

@type registration() :: %{
  sequence: non_neg_integer(),
  cid: binary(),
  token: binary(),
  registration_id: term()
}

t()

@opaque t()

Functions

active?(state, cid)

@spec active?(t(), binary()) :: boolean()

configure(state, peer_limit)

@spec configure(t(), integer()) :: {:ok, t()} | {:error, atom()}

new(initial, peer_limit \\ 2)

@spec new(binary(), integer()) :: {:ok, t()} | {:error, atom()}

published(state, sequence)

@spec published(t(), non_neg_integer()) :: {:ok, t()} | {:error, atom()}

Commit first transmission after successful registration and local send.

refill?(state)

@spec refill?(t()) :: boolean()

Whether one refill can be reserved without duplicating pending work.

registered(state, identity)

@spec registered(t(), term()) :: {:ok, t(), frame()} | {:error, :stale_registration}

Acknowledge the exact route registration and return its ready frame.

reserve(state, cid, token, registration_id)

@spec reserve(t(), binary(), binary(), term()) ::
  {:ok, t(), registration()} | {:error, atom()}

Reserve one route registration; this does not authorize advertisement.

retire(state, sequence, containing_dcid)

@spec retire(t(), non_neg_integer(), binary()) ::
  {:ok, t(), binary() | nil} | {:error, :invalid_connection_id_retirement}

Retire once, returning the route to remove without retaining its token.