Client API

client

Client-side entry point for WebTransport connections.

ClientDiagnostics dataclass

Encapsulate the client's health and statistics.

issues property

issues: list[str]

Return a list of potential health issues.

ClientStats dataclass

Encapsulate client-wide connection statistics.

avg_connect_time property

avg_connect_time: float

Return the average connection time.

success_rate property

success_rate: float

Return the connection success rate.

to_dict

to_dict() -> dict[str, Any]

Serialize statistics to a dictionary.

WebTransportClient

Manage WebTransport connections and sessions.

config property

config: ClientConfig

Return the client configuration.

is_closed property

is_closed: bool

Return True if the client is closed.

close async

close() -> None

Terminate the client and all underlying connections.

connect async

connect(*, url: URL, headers: Headers | None = None, wt_available_protocols: list[str] | None = None, timeout: float | None = None) -> WebTransportSession

Establish a WebTransport session.

diagnostics async

diagnostics() -> ClientDiagnostics

Retrieve a snapshot of the client's diagnostics and statistics.

set_default_headers

set_default_headers(*, headers: Headers) -> None

Configure default headers for all subsequent connections.