README
¶
Unlimited Websocket
Unlimitedws is a tiny, well-tested library which helps you build a robust Websocket server with a few lines of code. Specifically, the Websocket server can handle up to several million concurrent connections with only a few GBs of memory. The library has successfully done that by utilizing async IO, careful tuning OS, zero-upgrade TCP connections, efficient buffer reuse and worker pool in case of DDOS.
Prerequisites
- Linux OS
- Some MBs of memory :)
Installation
go get github.com/hxt365/unlimitedws
Usage
A robust Echo Websocket system, that handles 100k concurrent connections within only 200 MBs of memory, can be implemented as follows:
server, _ := unlimitedws.DefaultServer(":8000")
// OnConnect handles logic when a connection comes up
server.OnConnect = func(conn net.Conn) {
fmt.Println("welcome", nameConn(conn))
}
// OnRead handles logic when a connection sends a message
server.OnRead = func(conn net.Conn) error {
msg, op, err := wsutil.ReadClientData(conn)
if err != nil {
return err
}
err = wsutil.WriteServerMessage(conn, op, msg)
if err != nil {
return err
}
fmt.Println(string(msg))
return nil
}
// OnClose handles logic when a connection gets closed
server.OnClose = func(conn net.Conn) {
fmt.Println("goodbye", nameConn(conn))
}
server.Run()
Full example: Echo.
Built With
Unlimitedws is built on top of the excellent Gobwas library. It is highly recommended to read the documentation of that library for advanced usage.
Planning features
- Custom Cookie handler, for authentication purpose.
- Close orphan connections.
- Websocket fallbacks.
- Sending missing messages when reconnecting.
- Horizontal scaling.
Motivation
- Scaling WebSocket in Go and beyond article by Alexander Emelin.
- A Million WebSockets and Go article by Sergey Kamardin.
- Going Infinite, handling 1 millions websockets connections in Go video by Eran Yanay.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Server ¶
type Server struct {
// OnConnect handles logic when a connection comes up
OnConnect func(conn net.Conn)
// OnRead handles logic when a connection sends a message
OnRead func(conn net.Conn) error
// OnClose handles logic when a connection gets closed
OnClose func(conn net.Conn)
// contains filtered or unexported fields
}
func DefaultServer ¶
DefaultServer is a echo server with default config
func (*Server) Run ¶
func (s *Server) Run()
Run makes the server ready for accepting request. Here we use asyncIO, with the help of edge-triggered epoll, for the sake of performance. In addition, we use worker pool in order to prevent DDOS. If the server can not accept incoming request for some reasons (eg: run out of resources), we let the server cool down.
func (*Server) SetCooldownTime ¶
SetCooldownTime set cooldown time for the server
func (*Server) SetIOTimeout ¶
SetIOTimeout set io timeout for every readl/write call of connections To not set deadline, set timeout to 0
func (*Server) SetScheduleTimeout ¶
SetScheduleTimeout set schedule timeout for the server
Source Files
Directories