source: code/trunk/vendor/nhooyr.io/websocket/doc.go@ 822

Last change on this file since 822 was 822, checked in by yakumo.izuru, 22 months ago

Prefer immortal.run over runit and rc.d, use vendored modules
for convenience.

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

File size: 979 bytes
RevLine 
[822]1// +build !js
2
3// Package websocket implements the RFC 6455 WebSocket protocol.
4//
5// https://tools.ietf.org/html/rfc6455
6//
7// Use Dial to dial a WebSocket server.
8//
9// Use Accept to accept a WebSocket client.
10//
11// Conn represents the resulting WebSocket connection.
12//
13// The examples are the best way to understand how to correctly use the library.
14//
15// The wsjson and wspb subpackages contain helpers for JSON and protobuf messages.
16//
17// More documentation at https://nhooyr.io/websocket.
18//
19// Wasm
20//
21// The client side supports compiling to Wasm.
22// It wraps the WebSocket browser API.
23//
24// See https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
25//
26// Some important caveats to be aware of:
27//
28// - Accept always errors out
29// - Conn.Ping is no-op
30// - HTTPClient, HTTPHeader and CompressionMode in DialOptions are no-op
31// - *http.Response from Dial is &http.Response{} with a 101 status code on success
32package websocket // import "nhooyr.io/websocket"
Note: See TracBrowser for help on using the repository browser.