zzserver

README

zzServer

该项目是一个简易的socket服务端程序，

1. 支持webSocket以及普通tcpSocket
2. websocket支持BinaryMessage和TextMessage,且能支持同时解析json和protobuf协议

v1.0.6

• 增加了一个protobuf的使用例子,含有warp和unwarp方法
• 改为gin和websocket相结合,方便调用服务端功能

v1.0.4

• 增加了通过messageType来区分TextMessage和BinaryMessage

v1.0.3

• 增加了一个range方法, 用于遍历所有保存的客户端, 因为客户端单goroutine管理, 所以不能执行耗时操作,如数据库操作

使用示例

• 服务端

//开启服务
srv := zzserver.NewZZServer()

//设置gin,不设置会生成一个默认的
srv.GinEng = gin.Default()
srv.GinEng.GET("/hello", func(c *gin.Context) {
  c.JSON(http.StatusOK, gin.H{"code": 0})
})

srv.SetRouter(&P{}) //绑定路由接口
srv.WsPort = 9999   //websocket端口
//srv.TcpPort = 9988  //不设置就不会启动监听
srv.Start()


//遍历客户端

srv.Range(func(c *zzserver.Client) bool {
	fmt.Println(c.LastMsgTime)
	return true
})

• 客户端

ws://127.0.0.1:9999?messageType=text  发送字符串消息 (默认值)
ws://127.0.0.1:9999?messageType=binary   发送binary消息

请参考 example.go

by. douya

Documentation

Index

• type BaseRouter
  • func (b *BaseRouter) OnConnected(c *Client)
  • func (b *BaseRouter) OnDisconnect(c *Client)
  • func (b *BaseRouter) OnMessage(c *Client, message []byte)
  • func (b *BaseRouter) OnServerClose()
  • func (b *BaseRouter) OnServerUpdate()
• type Client
  • func (c *Client) Close()
  • func (c *Client) GetRemoteAddr() string
  • func (c *Client) SendByte(bytes []byte)
  • func (c *Client) SendJson(obj interface{}) error
  • func (c *Client) SendText(msg string)
• type IRouter
• type Server
  • func NewZZServer() *Server
  • func (h *Server) Close()
  • func (h *Server) Online() int
  • func (h *Server) Range(f func(c *Client) bool)
  • func (h *Server) SendToAll(message []byte)
  • func (h *Server) SendToAllJson(obj interface{})
  • func (h *Server) SetRouter(r IRouter)
  • func (h *Server) Start()

Types

type BaseRouter

type BaseRouter struct{}

BaseRouter 用于重写, 这样就不需要写出所有方法

func (*BaseRouter) OnConnected

func (b *BaseRouter) OnConnected(c *Client)

func (*BaseRouter) OnDisconnect

func (b *BaseRouter) OnDisconnect(c *Client)

func (*BaseRouter) OnMessage

func (b *BaseRouter) OnMessage(c *Client, message []byte)

func (*BaseRouter) OnServerClose

func (b *BaseRouter) OnServerClose()

func (*BaseRouter) OnServerUpdate

func (b *BaseRouter) OnServerUpdate()

type Client

type Client struct {
	Server          *Server     //server对线
	User            interface{} //用户对象
	UserData        sync.Map    //保存一些用户自定义内容
	ConnectionIndex int         //
	LastMsgTime     time.Time   //最后收到消息时间
	Ip              string      //登录IP
	WsMessageType   int         //websocket的协议类型,1:text, 2:binary
	// contains filtered or unexported fields
}

Client 保存客户端连接和用户

func (*Client) Close

func (c *Client) Close()

func (*Client) GetRemoteAddr

func (c *Client) GetRemoteAddr() string

GetRemoteAddr 获取地址

func (*Client) SendByte

func (c *Client) SendByte(bytes []byte)

SendByte 发送byte, socket会进行编码后再发送

func (*Client) SendJson

func (c *Client) SendJson(obj interface{}) error

SendJson 先把obj转为json对象再发送

func (*Client) SendText

func (c *Client) SendText(msg string)

SendText 发送消息 封装

type IRouter

type IRouter interface {
	OnMessage(c *Client, message []byte) // OnMessage 用户协程中调用
	OnDisconnect(c *Client)              // OnDisconnect hub协成中调用
	OnServerClose()                      // 关闭服务器执行一次
	OnServerUpdate()
	OnConnected(c *Client)
}

IRouter 方法2: 接口

type Server

type Server struct {

	//监听的端口
	WsPort  int
	TcpPort int

	ConnectionIndex int64 //连接计数

	GinEng *gin.Engine
	// contains filtered or unexported fields
}

Server maintains the set of active clients and broadcasts messages to the clients.

func NewZZServer

func NewZZServer() *Server

func (*Server) Close

func (h *Server) Close()

func (*Server) Online

func (h *Server) Online() int

func (*Server) Range

func (h *Server) Range(f func(c *Client) bool)

Range 在同一个go中执行, 不要执行很久的操作

func (*Server) SendToAll

func (h *Server) SendToAll(message []byte)

SendToAll 广播消息

func (*Server) SendToAllJson

func (h *Server) SendToAllJson(obj interface{})

SendToAllJson 广播消息

func (*Server) SetRouter

func (h *Server) SetRouter(r IRouter)

func (*Server) Start

func (h *Server) Start()