API Reference xturn_sockets v#2.2.1

View Source

Modules

Accept loop for connection-oriented transports (TCP, TLS, DTLS).

Per-tier packet framing state machine.

Frames packets using a fixed-size length header.

No framing: each push/3 is one immediately poppable packet.

Reordering decorator over any inner Accumulator.

Runtime configuration for :xturn_sockets.

Transport-level connection context passed to handlers.

Per-connection process: owns accumulator state and fully drains after each read.

Datagram listener that drains every whole packet from each inbound datagram.

Drain loop: pop every whole packet from a tier, dispatch the handler, repeat.

Business logic for one pipeline tier.

Declarative multi-tier pipeline specification.

One compiled pipeline tier: accumulator, handler, and dispatch strategy.

Data Channel Establishment Protocol (DCEP) encode and decode.

WebRTC SCTP association over a caller-owned byte pipe (typically DTLS application data).

Dynamic supervisor for per-connection Connection processes.

Normalizes {module, opts} or a bare module into {module, opts}.

Optional :telemetry events under [:xturn_sockets, event].

Worker that owns one async pipeline tier's accumulator and handler state.

Dynamic supervisor for async pipeline tier session workers.

Named pool supervisor for pipeline tiers with dispatch: :pool.

Named supervisor for pipeline tiers with dispatch: :task.

Uniform socket I/O behaviour for TCP, UDP, TLS, DTLS, and SCTP.

DTLS datagram transport for TURN and WebRTC-style secure datagram listeners.

SCTP transport (:gen_sctp) when the OTP driver is available.

Plain TCP transport (:gen_tcp) for TURN-over-TCP and outbound clients.

TLS stream transport (:ssl) for TURNS listeners and connections.

UDP transport (:gen_udp) for STUN/TURN listeners and relay data paths.