wt_h3 (webtransport v0.2.3)

View Source

HTTP/3 WebTransport protocol helpers.

This module bridges the generic HTTP/3 connection layer from quic_h3 with WebTransport-specific session negotiation and capsule handling.

Summary

Types

compat_mode/0
headers/0

Functions

close_session(H3Conn, SessionId, ErrorCode, Reason)

Send a CLOSE_WEBTRANSPORT_SESSION capsule on the CONNECT stream.

default_settings() deprecated
default_settings(_)

Return default H3 settings for the given compatibility mode.

detect_compat_mode(Headers)

Determine the compat mode (latest or legacy) from incoming CONNECT headers.

drain_session(H3Conn, SessionId)

Send a DRAIN_WEBTRANSPORT_SESSION capsule to signal graceful shutdown.

is_success_response(Headers)

Return true if the response headers contain a 2xx status code.

request_headers(Authority, Path)

Build WebTransport CONNECT request headers for the latest draft.

request_headers(Authority, Path, ExtraHeaders)

Build WebTransport CONNECT request headers with additional custom headers.

request_headers(Authority, Path, ExtraHeaders, _)

Build WebTransport CONNECT request headers for the specified compat mode.

request_session(H3Conn, Authority, Path, ExtraHeaders)

Send a WebTransport CONNECT request on the H3 connection, returning the stream ID.

request_session(H3Conn, Authority, Path, ExtraHeaders, CompatMode)

Send a WebTransport CONNECT request using the given compat mode.

response_status(Headers)

Extract the numeric HTTP status code from response headers.

send_capsule(H3Conn, SessionId, Capsule)

Encode and send a capsule on the CONNECT stream for the given session.

validate_wt_support(H3Conn, QuicConn)

Check that the peer advertises WebTransport support (latest draft).

validate_wt_support(H3Conn, QuicConn, CompatMode)

Check that the peer advertises WebTransport support for the given compat mode.

Types

compat_mode/0

-type compat_mode() :: latest | legacy_browser_compat.

headers/0

-type headers() :: [{binary(), binary()}].

Functions

close_session(H3Conn, SessionId, ErrorCode, Reason)

-spec close_session(pid(), non_neg_integer(), non_neg_integer(), binary()) -> ok | {error, term()}.

Send a CLOSE_WEBTRANSPORT_SESSION capsule on the CONNECT stream.

default_settings()

This function is deprecated. Use default_settings/1 with an explicit compat_mode. Retained for the eunit suite and external callers that haven't migrated. Returns the latest-spec settings.. 
-spec default_settings() -> map().

default_settings(_)

-spec default_settings(compat_mode()) -> map().

Return default H3 settings for the given compatibility mode.

detect_compat_mode(Headers)

-spec detect_compat_mode(headers()) -> {ok, compat_mode()} | {error, term()}.

Determine the compat mode (latest or legacy) from incoming CONNECT headers.

drain_session(H3Conn, SessionId)

-spec drain_session(pid(), non_neg_integer()) -> ok | {error, term()}.

Send a DRAIN_WEBTRANSPORT_SESSION capsule to signal graceful shutdown.

is_success_response(Headers)

-spec is_success_response(headers()) -> boolean().

Return true if the response headers contain a 2xx status code.

request_headers(Authority, Path)

-spec request_headers(binary(), binary()) -> headers().

Build WebTransport CONNECT request headers for the latest draft.

request_headers(Authority, Path, ExtraHeaders)

-spec request_headers(binary(), binary(), headers()) -> headers().

Build WebTransport CONNECT request headers with additional custom headers.

request_headers(Authority, Path, ExtraHeaders, _)

-spec request_headers(binary(), binary(), headers(), compat_mode()) -> headers().

Build WebTransport CONNECT request headers for the specified compat mode.

request_session(H3Conn, Authority, Path, ExtraHeaders)

-spec request_session(pid(), binary(), binary(), headers()) -> {ok, non_neg_integer()} | {error, term()}.

Send a WebTransport CONNECT request on the H3 connection, returning the stream ID.

request_session(H3Conn, Authority, Path, ExtraHeaders, CompatMode)

-spec request_session(pid(), binary(), binary(), headers(), compat_mode()) ->
                         {ok, non_neg_integer()} | {error, term()}.

Send a WebTransport CONNECT request using the given compat mode.

response_status(Headers)

-spec response_status(headers()) -> {ok, non_neg_integer()} | {error, term()}.

Extract the numeric HTTP status code from response headers.

send_capsule(H3Conn, SessionId, Capsule)

-spec send_capsule(pid(), non_neg_integer(), wt_h3_capsule:capsule()) -> ok | {error, term()}.

Encode and send a capsule on the CONNECT stream for the given session.

validate_wt_support(H3Conn, QuicConn)

-spec validate_wt_support(pid(), pid()) -> ok | {error, term()}.

Check that the peer advertises WebTransport support (latest draft).

validate_wt_support(H3Conn, QuicConn, CompatMode)

-spec validate_wt_support(pid(), pid(), compat_mode()) -> ok | {error, term()}.

Check that the peer advertises WebTransport support for the given compat mode.