diff options
Diffstat (limited to 'std/ws/README.md')
| -rw-r--r-- | std/ws/README.md | 181 |
1 files changed, 83 insertions, 98 deletions
diff --git a/std/ws/README.md b/std/ws/README.md index 5dcb9ce90..e4d924df6 100644 --- a/std/ws/README.md +++ b/std/ws/README.md @@ -12,57 +12,54 @@ import { acceptWebSocket, isWebSocketCloseEvent, isWebSocketPingEvent, - WebSocket, } from "https://deno.land/std/ws/mod.ts"; /** websocket echo server */ const port = Deno.args[0] || "8080"; console.log(`websocket server is running on :${port}`); for await (const req of serve(`:${port}`)) { - const { headers, conn } = req; - acceptWebSocket({ - conn, - headers, - bufReader: req.r, - bufWriter: req.w, - }) - .then( - async (sock: WebSocket): Promise<void> => { - console.log("socket connected!"); - const it = sock.receive(); - while (true) { - try { - const { done, value } = await it.next(); - if (done) { - break; - } - const ev = value; - if (typeof ev === "string") { - // text message - console.log("ws:Text", ev); - await sock.send(ev); - } else if (ev instanceof Uint8Array) { - // binary message - console.log("ws:Binary", ev); - } else if (isWebSocketPingEvent(ev)) { - const [, body] = ev; - // ping - console.log("ws:Ping", body); - } else if (isWebSocketCloseEvent(ev)) { - // close - const { code, reason } = ev; - console.log("ws:Close", code, reason); - } - } catch (e) { - console.error(`failed to receive frame: ${e}`); - await sock.close(1000).catch(console.error); - } + const { conn, r: bufReader, w: bufWriter, headers } = req; + + try { + const sock = await acceptWebSocket({ + conn, + bufReader, + bufWriter, + headers, + }); + + console.log("socket connected!"); + + try { + for await (const ev of sock) { + if (typeof ev === "string") { + // text message + console.log("ws:Text", ev); + await sock.send(ev); + } else if (ev instanceof Uint8Array) { + // binary message + console.log("ws:Binary", ev); + } else if (isWebSocketPingEvent(ev)) { + const [, body] = ev; + // ping + console.log("ws:Ping", body); + } else if (isWebSocketCloseEvent(ev)) { + // close + const { code, reason } = ev; + console.log("ws:Close", code, reason); } } - ) - .catch((err: Error): void => { - console.error(`failed to accept websocket: ${err}`); - }); + } catch (err) { + console.error(`failed to receive frame: ${err}`); + + if (!sock.isClosed) { + await sock.close(1000).catch(console.error); + } + } + } catch (err) { + console.error(`failed to accept websocket: ${err}`); + await req.respond({ status: 400 }); + } } ``` @@ -75,51 +72,58 @@ import { isWebSocketPingEvent, isWebSocketPongEvent, } from "https://deno.land/std/ws/mod.ts"; -import { encode } from "https://deno.land/std/strings/mod.ts"; +import { encode } from "https://deno.land/std/encoding/utf8.ts"; import { BufReader } from "https://deno.land/std/io/bufio.ts"; import { TextProtoReader } from "https://deno.land/std/textproto/mod.ts"; import { blue, green, red, yellow } from "https://deno.land/std/fmt/colors.ts"; const endpoint = Deno.args[0] || "ws://127.0.0.1:8080"; /** simple websocket cli */ -const sock = await connectWebSocket(endpoint); -console.log(green("ws connected! (type 'close' to quit)")); -(async function (): Promise<void> { - for await (const msg of sock.receive()) { - if (typeof msg === "string") { - console.log(yellow("< " + msg)); - } else if (isWebSocketPingEvent(msg)) { - console.log(blue("< ping")); - } else if (isWebSocketPongEvent(msg)) { - console.log(blue("< pong")); - } else if (isWebSocketCloseEvent(msg)) { - console.log(red(`closed: code=${msg.code}, reason=${msg.reason}`)); +try { + const sock = await connectWebSocket(endpoint); + console.log(green("ws connected! (type 'close' to quit)")); + + const messages = async (): Promise<void> => { + for await (const msg of sock) { + if (typeof msg === "string") { + console.log(yellow(`< ${msg}`)); + } else if (isWebSocketPingEvent(msg)) { + console.log(blue("< ping")); + } else if (isWebSocketPongEvent(msg)) { + console.log(blue("< pong")); + } else if (isWebSocketCloseEvent(msg)) { + console.log(red(`closed: code=${msg.code}, reason=${msg.reason}`)); + } } + }; + + const cli = async (): Promise<void> => { + const tpr = new TextProtoReader(new BufReader(Deno.stdin)); + while (true) { + await Deno.stdout.write(encode("> ")); + const line = await tpr.readLine(); + if (line === null) { + break; + } + if (line === "close") { + break; + } else if (line === "ping") { + await sock.ping(); + } else { + await sock.send(line); + } + } + }; + + await Promise.race([messages(), cli()]).catch(console.error); + + if (!sock.isClosed) { + await sock.close(1000).catch(console.error); } -})(); - -const tpr = new TextProtoReader(new BufReader(Deno.stdin)); -while (true) { - await Deno.stdout.write(encode("> ")); - const line = await tpr.readLine(); - if (line === null) { - break; - } - if (line === "close") { - break; - } else if (line === "ping") { - await sock.ping(); - } else { - await sock.send(line); - } - // FIXME: Without this, - // sock.receive() won't resolved though it is readable... - await new Promise((resolve): void => { - setTimeout(resolve, 0); - }); +} catch (err) { + console.error(red(`Could not connect to WebSocket: '${err}'`)); } -await sock.close(1000); -// FIXME: conn.close() won't shutdown process... + Deno.exit(0); ``` @@ -137,25 +141,6 @@ Returns true if input value is a WebSocketPingEvent, false otherwise. Returns true if input value is a WebSocketPongEvent, false otherwise. -### append - -This module is used to merge two Uint8Arrays. - -- note: This module might move to common/util. - -```ts -import { append } from "https://deno.land/std/ws/mod.ts"; - -// a = [1], b = [2] -append(a, b); // output: [1, 2] - -// a = [1], b = null -append(a, b); // output: [1] - -// a = [], b = [2] -append(a, b); // output: [2] -``` - ### unmask Unmask masked WebSocket payload. |