nnet

README

NNet 轻量级 TCP/WS/UDP 网络库

===

封装了

Documentation

Index

• type Engine
  • func NewEngine(conf config.EngineConf, opts ...RunOption) *Engine
  • func (ngin *Engine) AddRoutes(rs ...rt.Route)
  • func (ngin *Engine) ConnManager() *connection.Manager
  • func (ngin *Engine) Dial(addr string) (*connection.Connection, error)
  • func (ngin *Engine) Lifetime() lifetime.Lifetime
  • func (ngin *Engine) ListenSerial(conf serial.Config) error
  • func (ngin *Engine) ListenTCP(conf config.TCPServerConf) error
  • func (ngin *Engine) ListenWebsocket(conf config.WSServerConf) error
  • func (ngin *Engine) Pipeline() connection.Pipeline
  • func (ngin *Engine) Stop()
  • func (ngin *Engine) Use(middleware ...rt.Middleware)
• type PipelineOption
• type RunOption
  • func WithMiddleware(middleware ...rt.Middleware) RunOption
  • func WithNotFoundHandler(handler rt.Handler) RunOption
  • func WithPackerBuilder(fn packet.PackerBuilder) RunOption
  • func WithPipeline(pipeline connection.Pipeline) RunOption
  • func WithPipelineOpt(opts ...func(connection.Pipeline)) RunOption
  • func WithPool(pl *ants.Pool) RunOption
  • func WithPoolCfg(cfg npool.Config) RunOption
  • func WithRouter(router rt.Router) RunOption
  • func WithSerializer(s ndef.Serializer) RunOption
  • func WithTimerPrecision(precision time.Duration) RunOption

Types

type Engine

type Engine struct {
	config.EngineConf // 引擎配置
	// contains filtered or unexported fields
}

Engine 引擎

func NewEngine

func NewEngine(conf config.EngineConf, opts ...RunOption) *Engine

func (*Engine) AddRoutes

func (ngin *Engine) AddRoutes(rs ...rt.Route)

func (*Engine) ConnManager

func (ngin *Engine) ConnManager() *connection.Manager

ConnManager returns connection manager

func (*Engine) Dial

func (ngin *Engine) Dial(addr string) (*connection.Connection, error)

Dial 连接服务器

func (*Engine) Lifetime

func (ngin *Engine) Lifetime() lifetime.Lifetime

Lifetime returns lifetime interface.

func (*Engine) ListenSerial

func (ngin *Engine) ListenSerial(conf serial.Config) error

ListenSerial 监听串口消息

func (*Engine) ListenTCP

func (ngin *Engine) ListenTCP(conf config.TCPServerConf) error

func (*Engine) ListenWebsocket

func (ngin *Engine) ListenWebsocket(conf config.WSServerConf) error

ListenWebsocket 开始监听Websocket

func (*Engine) Pipeline

func (ngin *Engine) Pipeline() connection.Pipeline

Pipeline returns inner pipeline

func (*Engine) Stop

func (ngin *Engine) Stop()

func (*Engine) Use

func (ngin *Engine) Use(middleware ...rt.Middleware)

type PipelineOption

type PipelineOption func(opts connection.Pipeline)

type RunOption

type RunOption func(ngin *Engine)

RunOption defines the method to customize an Engine.

func WithMiddleware

func WithMiddleware(middleware ...rt.Middleware) RunOption

func WithNotFoundHandler

func WithNotFoundHandler(handler rt.Handler) RunOption

WithNotFoundHandler returns a RunOption with not found handler set to given handler.

func WithPackerBuilder

func WithPackerBuilder(fn packet.PackerBuilder) RunOption

WithPackerBuilder 设置 消息的封包/解包构造器

func WithPipeline

func WithPipeline(pipeline connection.Pipeline) RunOption

WithPipeline 使用自定义 pipeline

func WithPipelineOpt

func WithPipelineOpt(opts ...func(connection.Pipeline)) RunOption

WithPipelineOpt 使用默认Pipeline并设置其配置

func WithPool

func WithPool(pl *ants.Pool) RunOption

WithPool 设置使用自定义的工作池

func WithPoolCfg

func WithPoolCfg(cfg npool.Config) RunOption

WithPoolCfg 设置工作池配置

func WithRouter

func WithRouter(router rt.Router) RunOption

WithRouter 设置消息路由

func WithSerializer

func WithSerializer(s ndef.Serializer) RunOption

WithSerializer 设置消息的 序列化/反序列化 方式

func WithTimerPrecision

func WithTimerPrecision(precision time.Duration) RunOption

WithTimerPrecision 设置Timer精度，需在 Start 或 Dial 之前执行 注：精度需大于1ms, 并且不能在运行时更改 默认精度是 time.Second