socket_server

README

socket_server

介绍

{以下是 Gitee 平台说明，您可以替换此简介 Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台 无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 https://gitee.com/enterprises}

软件架构

软件架构说明

安装教程

1. xxxx
2. xxxx
3. xxxx

使用说明

1. xxxx
2. xxxx
3. xxxx

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

特技

1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md
2. Gitee 官方博客 blog.gitee.com
3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
4. GVP 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 https://gitee.com/help
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/

Documentation

Index

• type CmdClose
  • func (c *CmdClose) Exec() error
• type CmdInterface
• type CmdWrite
  • func (c *CmdWrite) Exec() error
• type Handler
• type Options
• type Server
  • func NewServer(options *Options) *Server
  • func (s *Server) Close() error
  • func (s *Server) GetSession(id uint32) (session *Session)
  • func (s *Server) Run() (err error)
• type Session
  • func (s *Session) Close() (err error)
  • func (s *Session) CloseWithError(err error) error
  • func (s *Session) ExecCommands(commands ...CmdInterface)
  • func (s *Session) Id() uint32
  • func (s *Session) NewCmdClose(err error) *CmdClose
  • func (s *Session) NewCommandWrite(data []byte) *CmdWrite
  • func (s *Session) Stopped() bool

Types

type CmdClose

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

func (*CmdClose) Exec

func (c *CmdClose) Exec() error

type CmdInterface

type CmdInterface interface {
	Exec() error
}

type CmdWrite

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

func (*CmdWrite) Exec

func (c *CmdWrite) Exec() error

type Handler

type Handler interface {
	HeaderHandler(headerData []byte, client *Session, thisRecv context.Context) (bodyLen int, thisRecvUpdated context.Context, err error)
	BodyHandler(bodyData []byte, client *Session, thisRecv context.Context) (err error)
	OnConnect(client *Session)
	OnError(err error, client *Session)
	HeaderLen() int
	OnClose(client *Session, err error)
}

type Options

type Options struct {
	Addr        string
	Handler     Handler
	BuffLen     int
	ReadTimeout time.Duration
}

type Server

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

func NewServer

func NewServer(options *Options) *Server

func (*Server) Close

func (s *Server) Close() error

func (*Server) GetSession

func (s *Server) GetSession(id uint32) (session *Session)

func (*Server) Run

func (s *Server) Run() (err error)

type Session

type Session struct {
	net.Conn

	Fields interface{}
	// contains filtered or unexported fields
}

func (*Session) Close

func (s *Session) Close() (err error)

func (*Session) CloseWithError

func (s *Session) CloseWithError(err error) error

func (*Session) ExecCommands

func (s *Session) ExecCommands(commands ...CmdInterface)

func (*Session) Id

func (s *Session) Id() uint32

func (*Session) NewCmdClose

func (s *Session) NewCmdClose(err error) *CmdClose

func (*Session) NewCommandWrite

func (s *Session) NewCommandWrite(data []byte) *CmdWrite

func (*Session) Stopped

func (s *Session) Stopped() bool