Source File
doc.go
Belonging Package
github.com/gobwas/ws
/*Package ws implements a client and server for the WebSocket protocol asspecified in RFC 6455.The main purpose of this package is to provide simple low-level API forefficient work with protocol.Overview.Upgrade to WebSocket (or WebSocket handshake) can be done in two ways.The first way is to use `net/http` server:http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {conn, _, _, err := ws.UpgradeHTTP(r, w)})The second and much more efficient way is so-called "zero-copy upgrade". Itavoids redundant allocations and copying of not used headers or other requestdata. User decides by himself which data should be copied.ln, err := net.Listen("tcp", ":8080")if err != nil {// handle error}conn, err := ln.Accept()if err != nil {// handle error}handshake, err := ws.Upgrade(conn)if err != nil {// handle error}For customization details see `ws.Upgrader` documentation.After WebSocket handshake you can work with connection in multiple ways.That is, `ws` does not force the only one way of how to work with WebSocket:header, err := ws.ReadHeader(conn)if err != nil {// handle err}buf := make([]byte, header.Length)_, err := io.ReadFull(conn, buf)if err != nil {// handle err}resp := ws.NewBinaryFrame([]byte("hello, world!"))if err := ws.WriteFrame(conn, frame); err != nil {// handle err}As you can see, it stream friendly:const N = 42ws.WriteHeader(ws.Header{Fin: true,Length: N,OpCode: ws.OpBinary,})io.CopyN(conn, rand.Reader, N)Or:header, err := ws.ReadHeader(conn)if err != nil {// handle err}io.CopyN(ioutil.Discard, conn, header.Length)For more info see the documentation.*/package ws
![]() |
The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds. |