https://github.com/hslam/websocket
Package websocket implements a client and server for the WebSocket protocol as specified in RFC 6455.
https://github.com/hslam/websocket
epoll fast go golang kqueue netpoll tls upgrade-conn upgrade-http websocket ws
Last synced: about 1 month ago
JSON representation
Package websocket implements a client and server for the WebSocket protocol as specified in RFC 6455.
- Host: GitHub
- URL: https://github.com/hslam/websocket
- Owner: hslam
- License: mit
- Created: 2020-07-13T04:41:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-17T13:58:50.000Z (about 2 years ago)
- Last Synced: 2025-03-30T11:32:42.925Z (2 months ago)
- Topics: epoll, fast, go, golang, kqueue, netpoll, tls, upgrade-conn, upgrade-http, websocket, ws
- Language: Go
- Homepage:
- Size: 104 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# websocket
[](https://pkg.go.dev/github.com/hslam/websocket)
[](https://github.com/hslam/websocket/actions)
[](https://codecov.io/gh/hslam/websocket)
[](https://goreportcard.com/report/github.com/hslam/websocket)
[](https://github.com/hslam/websocket/blob/master/LICENSE)
Package websocket implements a client and server for the WebSocket protocol as specified in [RFC 6455](https://tools.ietf.org/html/rfc6455 "RFC 6455").
## Feature
* Upgrade HTTP/Conn
* [Epoll/Kqueue](https://github.com/hslam/netpoll "netpoll")
* TLS
## [Benchmark](https://github.com/hslam/websocket-benchmark "websocket-benchmark")
## Get started
### Install
```
go get github.com/hslam/websocket
```
### Import
```
import "github.com/hslam/websocket"
```
### Usage
#### Example
server.go
```go
package main
import (
"github.com/hslam/mux"
"github.com/hslam/websocket"
"log"
"net/http"
"strings"
)
func main() {
m := mux.New()
m.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
conn, err := websocket.UpgradeHTTP(w, r)
if err != nil {
return
}
for {
var message string
err := conn.ReceiveMessage(&message)
if err != nil {
break
}
conn.SendMessage(strings.ToUpper(string(message)))
}
conn.Close()
}).GET()
log.Fatal(http.ListenAndServe(":8080", m))
}
```
server_poll.go
```go
package main
import (
"github.com/hslam/netpoll"
"github.com/hslam/websocket"
"net"
"strings"
)
func main() {
var handler = &netpoll.ConnHandler{}
handler.SetUpgrade(func(conn net.Conn) (netpoll.Context, error) {
return websocket.Upgrade(conn, nil)
})
handler.SetServe(func(context netpoll.Context) error {
ws := context.(*websocket.Conn)
var message string
err := ws.ReceiveMessage(&message)
if err != nil {
return err
}
return ws.SendMessage(strings.ToUpper(string(message)))
})
if err := netpoll.ListenAndServe("tcp", ":8080", handler); err != nil {
panic(err)
}
}
```
client.go
```go
package main
import (
"fmt"
"github.com/hslam/websocket"
"time"
)
func main() {
conn, err := websocket.Dial("tcp", "127.0.0.1:8080", "/", nil)
if err != nil {
panic(err)
}
defer conn.Close()
for i := 0; i < 1; i++ {
conn.SendMessage("Hello World")
var message string
err := conn.ReceiveMessage(&message)
if err != nil {
break
}
fmt.Println(message)
time.Sleep(time.Second)
}
}
```
**Output**
```
HELLO WORLD
```
**client.html**
```html
Websocket
UPPER
string:
result：
upper
var wsuri = "ws://127.0.0.1:8080/";
var ws = new WebSocket(wsuri);
ws.onmessage = function(e) {
var result = document.getElementById('result');
result.innerHTML = "result：" + e.data;
}
function send() {
var msg = document.getElementById('content').value;
ws.send(msg);
}
```
### License
This package is licensed under a MIT license (Copyright (c) 2020 Meng Huang)
### Author
websocket was written by Meng Huang.