README
¶
melody
fork from https://github.com/olahol/melody
Melody is websocket framework based on 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:
- Clear and easy interface similar to
net/httpor Gin. - A simple way to broadcast to all or selected connected sessions.
- Message buffers making concurrent writing safe.
- Automatic handling of ping/pong and session timeouts.
- Store data on sessions.
Install
go get github.com/huskar-t/melody
Example
Using Gin:
package main
import (
"github.com/gin-gonic/gin"
"github.com/huskar-t/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")
}
FAQ
If you are getting a 403 when trying to connect to your websocket you can change allow all origin hosts:
m := melody.New()
m.Upgrader.CheckOrigin = func(r *http.Request) bool { return true }
Documentation
¶
Index ¶
- Constants
- func FormatCloseMessage(closeCode int, text string) []byte
- type Config
- type Melody
- func (m *Melody) Broadcast(msg []byte) error
- func (m *Melody) BroadcastBinary(msg []byte) error
- func (m *Melody) BroadcastBinaryFilter(msg []byte, fn func(*Session) bool) error
- func (m *Melody) BroadcastBinaryOthers(msg []byte, s *Session) error
- func (m *Melody) BroadcastFilter(msg []byte, fn func(*Session) bool) error
- func (m *Melody) BroadcastMultiple(msg []byte, sessions []*Session) error
- func (m *Melody) BroadcastOthers(msg []byte, s *Session) error
- func (m *Melody) Close() error
- func (m *Melody) CloseWithMsg(msg []byte) error
- func (m *Melody) HandleClose(fn func(*Session, int, string) error)
- func (m *Melody) HandleConnect(fn func(*Session))
- func (m *Melody) HandleDisconnect(fn func(*Session))
- func (m *Melody) HandleError(fn func(*Session, error))
- func (m *Melody) HandleMessage(fn func(*Session, []byte))
- func (m *Melody) HandleMessageBinary(fn func(*Session, []byte))
- func (m *Melody) HandlePong(fn func(*Session))
- func (m *Melody) HandleRequest(w http.ResponseWriter, r *http.Request) error
- func (m *Melody) HandleRequestWithKeys(w http.ResponseWriter, r *http.Request, keys map[string]interface{}) error
- func (m *Melody) HandleSentMessage(fn func(*Session, []byte))
- func (m *Melody) HandleSentMessageBinary(fn func(*Session, []byte))
- func (m *Melody) IsClosed() bool
- func (m *Melody) Len() int
- type Session
- func (s *Session) Close() error
- func (s *Session) CloseWithMsg(msg []byte) error
- func (s *Session) Get(key string) (value interface{}, exists bool)
- func (s *Session) GetConn() *websocket.Conn
- func (s *Session) IsClosed() bool
- func (s *Session) MustGet(key string) interface{}
- func (s *Session) Set(key string, value interface{})
- func (s *Session) Write(msg []byte) error
- func (s *Session) WriteBinary(msg []byte) error
- func (s *Session) WriteControl(messageType int, data []byte, deadline time.Time) error
Constants ¶
const ( StatusNormal = uint32(1) StatusStop = uint32(2) )
Variables ¶
This section is empty.
Functions ¶
func FormatCloseMessage ¶
FormatCloseMessage formats closeCode and text as a WebSocket close message.
Types ¶
type Config ¶
type Config struct {
WriteWait time.Duration // Milliseconds until write times out.
PongWait time.Duration // Timeout for waiting on pong.
PingPeriod time.Duration // Milliseconds between pings.
MaxMessageSize int64 // Maximum size in bytes of a message.
MessageBufferSize int // The max amount of messages that can be in a sessions buffer before it starts dropping them.
}
Config melody configuration struct.
type Melody ¶
type Melody struct {
Config *Config
UpGrader *websocket.Upgrader
// contains filtered or unexported fields
}
Melody implements a websocket manager.
func (*Melody) BroadcastBinary ¶
BroadcastBinary broadcasts a binary message to all sessions.
func (*Melody) BroadcastBinaryFilter ¶
BroadcastBinaryFilter broadcasts a binary message to all sessions that fn returns true for.
func (*Melody) BroadcastBinaryOthers ¶
BroadcastBinaryOthers broadcasts a binary message to all sessions except session s.
func (*Melody) BroadcastFilter ¶
BroadcastFilter broadcasts a text message to all sessions that fn returns true for.
func (*Melody) BroadcastMultiple ¶
BroadcastMultiple broadcasts a text message to multiple sessions given in the sessions slice.
func (*Melody) BroadcastOthers ¶
BroadcastOthers broadcasts a text message to all sessions except session s.
func (*Melody) CloseWithMsg ¶
CloseWithMsg closes the melody instance with the given close payload and all connected sessions. Use the FormatCloseMessage function to format a proper close message payload.
func (*Melody) HandleClose ¶
HandleClose sets the handler for close messages received from the session. The code argument to h is the received close code or CloseNoStatusReceived if the close message is empty. The default close handler sends a close frame back to the session.
The application must read the connection to process close messages as described in the section on Control Frames above.
The connection read methods return a CloseError when a close frame is received. Most applications should handle close messages as part of their normal error handling. Applications should only set a close handler when the application must perform some action before sending a close frame back to the session.
func (*Melody) HandleConnect ¶
HandleConnect fires fn when a session connects.
func (*Melody) HandleDisconnect ¶
HandleDisconnect fires fn when a session disconnects.
func (*Melody) HandleError ¶
HandleError fires fn when a session has an error.
func (*Melody) HandleMessage ¶
HandleMessage fires fn when a text message comes in.
func (*Melody) HandleMessageBinary ¶
HandleMessageBinary fires fn when a binary message comes in.
func (*Melody) HandlePong ¶
HandlePong fires fn when a pong is received from a session.
func (*Melody) HandleRequest ¶
HandleRequest upgrades http requests to websocket connections and dispatches them to be handled by the melody instance.
func (*Melody) HandleRequestWithKeys ¶
func (m *Melody) HandleRequestWithKeys(w http.ResponseWriter, r *http.Request, keys map[string]interface{}) error
HandleRequestWithKeys does the same as HandleRequest but populates session.Keys with keys.
func (*Melody) HandleSentMessage ¶
HandleSentMessage fires fn when a text message is successfully sent.
func (*Melody) HandleSentMessageBinary ¶
HandleSentMessageBinary fires fn when a binary message is successfully sent.
type Session ¶
type Session struct {
Request *http.Request
Keys sync.Map
// contains filtered or unexported fields
}
Session wrapper around websocket connections.
func (*Session) CloseWithMsg ¶
CloseWithMsg closes the session with the provided payload. Use the FormatCloseMessage function to format a proper close message payload.
func (*Session) Get ¶
Get returns the value for the given key, ie: (value, true). If the value does not exists it returns (nil, false)
func (*Session) MustGet ¶
MustGet returns the value for the given key if it exists, otherwise it panics.
func (*Session) Set ¶
Set is used to store a new key/value pair exclusivelly for this session. It also lazy initializes s.Keys if it was not used previously.
func (*Session) WriteBinary ¶
WriteBinary writes a binary message to session.
Source Files