MOQX.Protocol behaviour (moqx v0.8.1)

Copy Markdown View Source

Contract between the protocol-neutral connection runtime and one concrete MOQT-family protocol implementation.

Implementations own their wire messages, codecs, lifecycle, capabilities, commands, events, and error semantics. The runtime owns the MOQX.Transport context and applies the transport actions returned in MOQX.Protocol.Transition values.

Summary

Types

id()
runtime_event()
state()

Callbacks

capabilities(state)
handle_operation(state, t)
handle_transport(state, arg2)
id()
init(endpoint, options)
transport_spec(endpoint, options)

Functions

implementation?(module)

Returns whether a module exports the complete protocol implementation contract.

Types

id()

@type id() :: :cloudflare_draft_14 | :draft_16

runtime_event()

@type runtime_event() :: {:runtime_timeout, term()}

state()

@type state() :: term()

Callbacks

capabilities(state)

@callback capabilities(state()) :: MOQX.Protocol.Capabilities.t()

handle_operation(state, t)

@callback handle_operation(state(), MOQX.Operation.t()) ::
  MOQX.Protocol.Transition.result()

handle_transport(state, arg2)

@callback handle_transport(state(), MOQX.Transport.event() | runtime_event()) ::
  MOQX.Protocol.Transition.result()

id()

@callback id() :: id() | atom()

init(endpoint, options)

@callback init(endpoint :: URI.t(), options :: keyword()) ::
  {:ok, state()} | {:error, term()}

transport_spec(endpoint, options)

@callback transport_spec(endpoint :: URI.t(), options :: keyword()) ::
  {:ok, MOQX.Protocol.TransportSpec.t()} | {:error, term()}

Functions

implementation?(module)

@spec implementation?(module()) :: boolean()

Returns whether a module exports the complete protocol implementation contract.