Ola
119 lines
2.9 KiB
Markdown
119 lines
2.9 KiB
Markdown
# melody
|
|
|
|
[](https://travis-ci.org/olahol/melody)
|
|
[](https://coveralls.io/r/olahol/melody)
|
|
[](https://godoc.org/github.com/olahol/melody)
|
|
|
|
> :notes: Minimalist websocket framework for Go.
|
|
|
|
Melody is websocket framework based on [github.com/gorilla/websocket](https://github.com/gorilla/websocket)
|
|
that abstracts away the tedious parts of handling websockets. It gets out of
|
|
your way so you can write real-time apps. Features include:
|
|
|
|
* [x] Clear and easy interface similar to `net/http` or Gin.
|
|
* [x] A simple way to broadcast to all or selected connected sessions.
|
|
* [x] Message buffers making concurrent writing safe.
|
|
* [x] Automatic handling of ping/pong and session timeouts.
|
|
* [x] Store data on sessions.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
go get github.com/olahol/melody
|
|
```
|
|
|
|
## [Example: chat](https://github.com/olahol/melody/tree/master/examples/chat)
|
|
|
|
[](https://github.com/olahol/melody/tree/master/examples/chat)
|
|
|
|
Using [Gin](https://github.com/gin-gonic/gin):
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/olahol/melody"
|
|
"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")
|
|
}
|
|
```
|
|
|
|
Using [Echo](https://github.com/labstack/echo):
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"github.com/labstack/echo/v4"
|
|
"github.com/labstack/echo/v4/middleware"
|
|
"github.com/olahol/melody"
|
|
"net/http"
|
|
)
|
|
|
|
func main() {
|
|
e := echo.New()
|
|
m := melody.New()
|
|
|
|
e.Use(middleware.Logger())
|
|
e.Use(middleware.Recover())
|
|
|
|
e.GET("/", func(c echo.Context) error {
|
|
http.ServeFile(c.Response().Writer, c.Request(), "index.html")
|
|
return nil
|
|
})
|
|
|
|
e.GET("/ws", func(c echo.Context) error {
|
|
m.HandleRequest(c.Response().Writer, c.Request())
|
|
return nil
|
|
})
|
|
|
|
m.HandleMessage(func(s *melody.Session, msg []byte) {
|
|
m.Broadcast(msg)
|
|
})
|
|
|
|
e.Logger.Fatal(e.Start(":5000"))
|
|
}
|
|
```
|
|
|
|
### [More examples](https://github.com/olahol/melody/tree/master/examples)
|
|
|
|
## [Documentation](https://godoc.org/github.com/olahol/melody)
|
|
|
|
## Contributors
|
|
|
|
* Ola Holmström (@olahol)
|
|
* Shogo Iwano (@shiwano)
|
|
* Matt Caldwell (@mattcaldwell)
|
|
* Heikki Uljas (@huljas)
|
|
* Robbie Trencheny (@robbiet480)
|
|
* yangjinecho (@yangjinecho)
|
|
* lesismal (@lesismal)
|
|
* parkerzhu (@parkerzhu)
|
|
* gabstv (@gabstv)
|
|
|
|
## FAQ
|
|
|
|
If you are getting a `403` when trying to connect to your websocket you can [change allow all origin hosts](http://godoc.org/github.com/gorilla/websocket#hdr-Origin_Considerations):
|
|
|
|
```go
|
|
m := melody.New()
|
|
m.Upgrader.CheckOrigin = func(r *http.Request) bool { return true }
|
|
```
|