Struct ockam_transport_websocket::WebSocketTransport

pub struct WebSocketTransport { /* fields omitted */ }

High level management interface for WebSocket transports

Be aware that only one WebSocketTransport can exist per node, as it registers itself as a router for the WS address type. Multiple calls to WebSocketTransport::create will fail.

To register additional connections on an already initialised WebSocketTransport, use ws.connect(). To listen for incoming connections use ws.listen()

use ockam_transport_websocket::WebSocketTransport;
let ws = WebSocketTransport::create(&ctx).await?;
ws.listen("127.0.0.1:8000").await?; // Listen on port 8000
ws.connect("127.0.0.1:5000").await?; // And connect to port 5000

The same WebSocketTransport can also bind to multiple ports.

let ws = WebSocketTransport::create(&ctx).await?;
ws.listen("127.0.0.1:8000").await?; // Listen on port 8000
ws.listen("127.0.0.1:9000").await?; // Listen on port 9000

Implementations

impl WebSocketTransport

pub async fn create(ctx: &Context) -> Result<WebSocketTransport>

Create a new WebSocket transport and router for the current node

pub async fn connect<S: Into<String>>(&self, peer: S) -> Result<()>

Establish an outgoing WebSocket connection on an existing transport

pub async fn listen<S: Into<String>>(&self, bind_addr: S) -> Result<()>

Start listening to incoming connections on an existing transport