gnetws

README

gnetws

Documentation

Index

• type OnCloseHandler
• type OnConnectHandler
• type OnErrorHandler
• type OnMessageHandler
• type OnTickHandler
• type ServerOption
  • func Address(network, port string) ServerOption
  • func IdleTimeout(timeout time.Duration) ServerOption
  • func OnCloseHandle(h OnCloseHandler) ServerOption
  • func OnConnectHandle(h OnConnectHandler) ServerOption
  • func OnMessageHandle(h OnMessageHandler) ServerOption
  • func OnTickHandle(h OnTickHandler) ServerOption
  • func ReadTimeout(timeout time.Duration) ServerOption
  • func StopTimeout(timeout time.Duration) ServerOption
  • func TickTime(timeout time.Duration) ServerOption
  • func WithLoadBalancing(lb gnet.LoadBalancing) ServerOption
  • func WithLogger(logger *zap.Logger) ServerOption
  • func WithMaxConn(maxConn int) ServerOption
• type WsCodec
  • func (w *WsCodec) Decode(c gnet.Conn) (outs []wsutil.Message, err error)
• type WsServer
  • func Run(opts ...ServerOption) *WsServer
  • func (wss *WsServer) OnBoot(eng gnet.Engine) gnet.Action
  • func (wss *WsServer) OnClose(c gnet.Conn, err error) (action gnet.Action)
  • func (wss *WsServer) OnOpen(c gnet.Conn) ([]byte, gnet.Action)
  • func (wss *WsServer) OnTick() (delay time.Duration, action gnet.Action)
  • func (wss *WsServer) OnTraffic(c gnet.Conn) (action gnet.Action)
  • func (wss *WsServer) Start()
  • func (wss *WsServer) Stop(ctx context.Context)

Types

type OnCloseHandler

type OnCloseHandler func(gnet.Conn)

OnCloseHandler 断开连接时处理

type OnConnectHandler

type OnConnectHandler func(gnet.Conn, *WsCodec)

OnConnectHandler 建立连接时处理

type OnErrorHandler

type OnErrorHandler func(gnet.Conn, error)

OnErrorHandler 出现错误时处理

type OnMessageHandler

type OnMessageHandler func(gnet.Conn, wsutil.Message) error

OnMessageHandler 收到消息时处理

type OnTickHandler

type OnTickHandler func()

OnTickHandler 定时任务

type ServerOption

type ServerOption func(o *WsServer)

func Address

func Address(network, port string) ServerOption

func IdleTimeout

func IdleTimeout(timeout time.Duration) ServerOption

IdleTimeout 连接的空闲超时时间

func OnCloseHandle

func OnCloseHandle(h OnCloseHandler) ServerOption

func OnConnectHandle

func OnConnectHandle(h OnConnectHandler) ServerOption

func OnMessageHandle

func OnMessageHandle(h OnMessageHandler) ServerOption

func OnTickHandle

func OnTickHandle(h OnTickHandler) ServerOption

func ReadTimeout

func ReadTimeout(timeout time.Duration) ServerOption

ReadTimeout 连接的读超时时间

func StopTimeout

func StopTimeout(timeout time.Duration) ServerOption

StopTimeout GNet的停止超时时间

func TickTime

func TickTime(timeout time.Duration) ServerOption

TickTime 定时执行时间间隔

func WithLoadBalancing

func WithLoadBalancing(lb gnet.LoadBalancing) ServerOption

func WithLogger

func WithLogger(logger *zap.Logger) ServerOption

func WithMaxConn

func WithMaxConn(maxConn int) ServerOption

type WsCodec

type WsCodec struct {
	Uuid string // 连接的唯一ID
	// contains filtered or unexported fields
}

func (*WsCodec) Decode

func (w *WsCodec) Decode(c gnet.Conn) (outs []wsutil.Message, err error)

type WsServer

type WsServer struct {
	gnet.BuiltinEventEngine
	// contains filtered or unexported fields
}

func Run

func Run(opts ...ServerOption) *WsServer

func (*WsServer) OnBoot

func (wss *WsServer) OnBoot(eng gnet.Engine) gnet.Action

func (*WsServer) OnClose

func (wss *WsServer) OnClose(c gnet.Conn, err error) (action gnet.Action)

func (*WsServer) OnOpen

func (wss *WsServer) OnOpen(c gnet.Conn) ([]byte, gnet.Action)

func (*WsServer) OnTick

func (wss *WsServer) OnTick() (delay time.Duration, action gnet.Action)

func (*WsServer) OnTraffic

func (wss *WsServer) OnTraffic(c gnet.Conn) (action gnet.Action)

func (*WsServer) Start

func (wss *WsServer) Start()

func (*WsServer) Stop

func (wss *WsServer) Stop(ctx context.Context)