Skip to content

WsLink

WsLink(url, *, ssl_context=None, ping_interval=20.0, ping_timeout=20.0, open_timeout=10.0)

Factory for :class:WsLinkClient against a single hub URL.

Mirrors the :class:LocalLink shape so callers that hold a link handle and request clients on demand work identically over WebSocket. Each :meth:client call returns a fresh, unopened :class:WsLinkClient; the caller is responsible for await client.open().

Source code in autogen/beta/network/transport/ws.py
def __init__(
    self,
    url: str,
    *,
    ssl_context: Any = None,
    ping_interval: float | None = 20.0,
    ping_timeout: float | None = 20.0,
    open_timeout: float | None = 10.0,
) -> None:
    # __init__ stores params; no side effects.
    self._url = url
    self._ssl = ssl_context
    self._ping_interval = ping_interval
    self._ping_timeout = ping_timeout
    self._open_timeout = open_timeout

url property #

url

client #

client()
Source code in autogen/beta/network/transport/ws.py
def client(self) -> WsLinkClient:
    return WsLinkClient(
        self._url,
        ssl_context=self._ssl,
        ping_interval=self._ping_interval,
        ping_timeout=self._ping_timeout,
        open_timeout=self._open_timeout,
    )