Ola Holmström
59 lines
1.5 KiB
Markdown
59 lines
1.5 KiB
Markdown
# melody
|
|
|
|
[](https://godoc.org/github.com/olahol/melody)
|
|
[](https://travis-ci.org/olahol/melody)
|
|
|
|
> :notes: Simple websocket framework for Go
|
|
|
|
Melody is websocket framework based on [github.com/gorilla/websocket](https://github.com/gorilla/websocket)
|
|
that abstracts away the more tedious parts of handling websockets. Features include:
|
|
|
|
* [x] Timeouts for write and read.
|
|
* [x] Built-in ping/pong handling.
|
|
* [x] Message buffer for connections making concurrent writing easy.
|
|
* [x] Simple broadcasting to all or selected sessions.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
go get github.com/olahol/melody
|
|
```
|
|
|
|
## [Example](https://github.com/olahol/melody/tree/master/examples)
|
|
|
|
[Simple broadcasting chat server](https://github.com/olahol/melody/tree/master/examples/chat),
|
|
error handling left as en exercise for the developer.
|
|
|
|
[](https://github.com/olahol/melody/tree/master/examples/chat)
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"github.com/olahol/melody"
|
|
"github.com/gin-gonic/gin"
|
|
"net/http"
|
|
)
|
|
|
|
func main() {
|
|
r := gin.Default()
|
|
m := melody.New()
|
|
|
|
r.GET("/", func(c *gin.Context) {
|
|
http.ServeFile(c.Writer, c.Request, "index.html")
|
|
})
|
|
|
|
r.GET("/ws", func(c *gin.Context) {
|
|
m.HandleRequest(c.Writer, c.Request)
|
|
})
|
|
|
|
m.HandleMessage(func(s *melody.Session, msg []byte) {
|
|
m.Broadcast(msg)
|
|
})
|
|
|
|
r.Run(":5000")
|
|
}
|
|
```
|
|
|
|
### [Documentation](https://godoc.org/github.com/olahol/melody)
|