pub struct WebSocket<S> { /* private fields */ }tokio only.Expand description
A WebSocket, as S2 Connect specifies it.
Implementations§
Source§impl WebSocket<MaybeTlsStream<TcpStream>>
impl WebSocket<MaybeTlsStream<TcpStream>>
Sourcepub async fn connect(url: &str, bearer: Option<&str>) -> Result<Self, Error>
pub async fn connect(url: &str, bearer: Option<&str>) -> Result<Self, Error>
Connect to a URL, with the bearer token S2 Connect’s session initiation issued.
S2C §Authentication: “the client must authenticate itself using the
commToken in the authorization header of the websocket connection request”.
TLS is verified against the public PKI, which is right for a WAN endpoint and
wrong for a LAN one: a wss://EVSE1038.local/s2 certificate is self-signed, and
what makes it trustworthy is the CA pinned during pairing. Use
connect_with_policy there.
Sourcepub async fn open(
url: &str,
options: &WebSocketOptions<'_>,
) -> Result<Self, Error>
pub async fn open( url: &str, options: &WebSocketOptions<'_>, ) -> Result<Self, Error>
Connect with everything spelled out: bearer, size cap and TLS policy.
Sourcepub async fn connect_with_policy(
url: &str,
bearer: Option<&str>,
policy: &TlsPolicy,
) -> Result<Self, Error>
Available on crate feature connect-client only.
pub async fn connect_with_policy( url: &str, bearer: Option<&str>, policy: &TlsPolicy, ) -> Result<Self, Error>
connect-client only.Connect under a TlsPolicy — which, after a LAN
pairing, is the CA that pairing pinned.
This is the companion of connect::client::Session and
the one to use in a LAN. The session initiation that produced the communication
token ran against the pinned CA; connecting the WebSocket against a bundled root
list instead would either fail outright — which is what it does — or, worse,
succeed against a different server.
let socket = WebSocket::connect_with_policy(url, Some(token), &paired.policy()).await?;Source§impl<S> WebSocket<S>
impl<S> WebSocket<S>
Sourcepub fn from_stream(stream: WebSocketStream<S>) -> Self
pub fn from_stream(stream: WebSocketStream<S>) -> Self
Wrap an already-established WebSocket — one a server accepted, for instance.