gnetws

package module

v0.1.2 Latest Latest Go to latest Published: Nov 30, 2023 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Pius-x/gnetws

Links

Open Source Insights

README ¶

gnetws

Documentation ¶

Index ¶

type OnCloseHandler
type OnConnectHandler
type OnErrorHandler
type OnMessageHandler
type OnTickHandler
type ServerOption
type WsCodec
- func (w *WsCodec) Decode(c gnet.Conn) (outs []wsutil.Message, err error)
type WsServer
- func Run(opts ...ServerOption) *WsServer

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 ¶ added in v0.0.10

func WithLogger(logger *zap.Logger) ServerOption

func WithMaxConn ¶ added in v0.0.6

func WithMaxConn(maxConn int) ServerOption

type WsCodec ¶ added in v0.0.6

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

func (*WsCodec) Decode ¶ added in v0.0.6

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

type WsServer ¶ added in v0.0.6

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

func Run ¶

func Run(opts ...ServerOption) *WsServer

func (*WsServer) OnBoot ¶ added in v0.0.6

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

func (*WsServer) OnClose ¶ added in v0.0.6

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

func (*WsServer) OnOpen ¶ added in v0.0.6

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

func (*WsServer) OnTick ¶ added in v0.0.6

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

func (*WsServer) OnTraffic ¶ added in v0.0.6

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

func (*WsServer) Start ¶ added in v0.0.6

func (wss *WsServer) Start()

func (*WsServer) Stop ¶ added in v0.0.6

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
utils
zaplog

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL