34 lines
1.0 KiB
Go
34 lines
1.0 KiB
Go
//go:build !js
|
|
|
|
// Package websocket implements the RFC 6455 WebSocket protocol.
|
|
//
|
|
// https://tools.ietf.org/html/rfc6455
|
|
//
|
|
// Use Dial to dial a WebSocket server.
|
|
//
|
|
// Use Accept to accept a WebSocket client.
|
|
//
|
|
// Conn represents the resulting WebSocket connection.
|
|
//
|
|
// The examples are the best way to understand how to correctly use the library.
|
|
//
|
|
// The wsjson subpackage contain helpers for JSON and protobuf messages.
|
|
//
|
|
// More documentation at https://github.com/coder/websocket.
|
|
//
|
|
// # Wasm
|
|
//
|
|
// The client side supports compiling to Wasm.
|
|
// It wraps the WebSocket browser API.
|
|
//
|
|
// See https://developer.mozilla.org/en-US/docs/Web/API/WebSocket
|
|
//
|
|
// Some important caveats to be aware of:
|
|
//
|
|
// - Accept always errors out
|
|
// - Conn.Ping is no-op
|
|
// - Conn.CloseNow is Close(StatusGoingAway, "")
|
|
// - HTTPClient, HTTPHeader and CompressionMode in DialOptions are no-op
|
|
// - *http.Response from Dial is &http.Response{} with a 101 status code on success
|
|
package websocket // import "github.com/coder/websocket"
|