diff --git a/docs/mkdocs/src/transports/ws_client.md b/docs/mkdocs/src/transports/ws_client.md index ad9c2456..6d9cacbf 100644 --- a/docs/mkdocs/src/transports/ws_client.md +++ b/docs/mkdocs/src/transports/ws_client.md @@ -1,11 +1,11 @@ -UDP TRANSPORT -============= +WEBSOCKET CLIENT TRANSPORT +========================== -The UDP transport is a UDP socket, receiving packets on a specified port number, and sending packets to a specified host and port number. +The WebSocket Client transport is WebSocket connection to a WebSocket server over which HCI packets +are sent and received. ## Moniker -The moniker syntax for a UDP transport is: `udp::,:`. +The moniker syntax for a WebSocket Client transport is: `ws-client:` !!! example - `udp:0.0.0.0:9000,127.0.0.1:9001` - UDP transport where packets are received on port `9000` and sent to `127.0.0.1` on port `9001` + `ws-client:ws://localhost:1234/some/path` diff --git a/docs/mkdocs/src/transports/ws_server.md b/docs/mkdocs/src/transports/ws_server.md index ad9c2456..8986d3f2 100644 --- a/docs/mkdocs/src/transports/ws_server.md +++ b/docs/mkdocs/src/transports/ws_server.md @@ -1,11 +1,13 @@ -UDP TRANSPORT -============= +WEBSOCKET SERVER TRANSPORT +========================== -The UDP transport is a UDP socket, receiving packets on a specified port number, and sending packets to a specified host and port number. +The WebSocket Server transport is WebSocket server that accepts connections from a WebSocket +client. HCI packets are sent and received over the connection. ## Moniker -The moniker syntax for a UDP transport is: `udp::,:`. +The moniker syntax for a WebSocket Server transport is: `ws-server::`, +where `` may be the address of a local network interface, or `_`to accept connections on all local network interfaces. `` is the TCP port number on which to accept connections. + !!! example - `udp:0.0.0.0:9000,127.0.0.1:9001` - UDP transport where packets are received on port `9000` and sent to `127.0.0.1` on port `9001` + `ws-server:_:9001`