Struct WsFramedStream 

pub struct WsFramedStream { /* private fields */ }

A WebSocket-backed FramedStream.

Uses split read/write halves to avoid mutex contention between the heartbeat task and the main send/recv path:

• Write half (SplitSink): Shared via Arc<Mutex<_>> between send() and the heartbeat task (which sends Ping frames).
• Read half (SplitStream): Owned exclusively by recv() — no mutex needed.
• Heartbeat: Sends Ping on the write half at ping_interval. Tracks last Pong via Arc<AtomicU64> (epoch millis). If last_pong exceeds pong_timeout, the connection is closed.

Implementations

impl WsFramedStream

pub fn remote_peer_id(&self) -> &str

Get the remote peer’s Tailscale stable ID (from the hello envelope).

This is the session layer’s routing key. For the application-visible device identifier, use remote_identity().device_id.

pub fn remote_identity(&self) -> Option<&PeerIdentity>

Get the full remote PeerIdentity advertised in the hello envelope.

Returns None only in test fixtures that synthesise a stream without running the hello exchange — production streams always have this.

Trait Implementations

impl Debug for WsFramedStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for WsFramedStream

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl FramedStream for WsFramedStream

async fn send(&mut self, data: &[u8]) -> Result<(), TransportError>

Send a binary message to the peer.

async fn recv(&mut self) -> Result<Option<Vec<u8>>, TransportError>

Receive the next binary message from the peer.

async fn close(&mut self) -> Result<(), TransportError>

Gracefully close the stream.

fn peer_addr(&self) -> String

The remote peer’s address as a human-readable string.

impl Sync for WsFramedStream