ws

package

v1.1.3 Latest Latest Go to latest Published: Sep 27, 2022 License: MIT Imports: 11 Imported by: 0

Details

This section is empty.

This section is empty.

func NewWrapConnection(netConn net.Conn) *connection

type Conn interface {
	ID() string
	Push(msg []byte) error
	IP() string
	Property() *Property
}

Conn websocket connection

type Context struct {
	context.Context
	// contains filtered or unexported fields
}

func NewContext(conn Conn, body []byte) *Context

func (ctx *Context) Body() []byte

func (ctx *Context) Conn() Conn

func (ctx *Context) Output(msg []byte)

type Property struct {
	// contains filtered or unexported fields
}

func (p *Property) Get(key string) any

func (p *Property) GetString(key string) string

func (p *Property) Set(key string, value any)

type Server struct {
	// contains filtered or unexported fields
}

Server provide the websocket server.

func NewServer(bind string) *Server

func (server *Server) OnConnect(handler func(conn Conn)) *Server

OnConnect is set callback when the connection is established

func (server *Server) OnDisconnect(handler func(conn Conn)) *Server

OnDisconnect is set callback when the client disconnects from the server

func (server *Server) OnMessage(handler func(ctx *Context)) *Server

OnMessage is set callback when a message is received.

func (server *Server) Serve(stop <-chan struct{})

Serve start websocket server

func (server *Server) Shutdown()

Shutdown stop websocket server.

func (server *Server) WithWorker(worker int) *Server

WithWorker sets the concurrent worker threads.