znet

Documentation

Index

• func CallBackToClient(conn *net.TCPConn, data []byte, cnt int) error
• func NewServer() ziface.IServer
• type BaseRouter
  • func (br *BaseRouter) Handle(req ziface.IRequest)
• type Connection
  • func NewConntion(conn *net.TCPConn, connID uint32, msgHandler ziface.IMsgHandle) *Connection
  • func (c *Connection) GetConnID() uint32
  • func (c *Connection) GetTCPConnection() *net.TCPConn
  • func (c *Connection) RemoteAddr() net.Addr
  • func (c *Connection) SendMsg(msgId uint32, data []byte) error
  • func (c *Connection) Start()
  • func (c *Connection) StartReader()
  • func (c *Connection) Stop()
• type DataPack
  • func NewDataPack() *DataPack
  • func (dp *DataPack) GetHeadLen() uint32
  • func (dp *DataPack) Pack(msg ziface.IMessage) ([]byte, error)
  • func (dp *DataPack) Unpack(binaryData []byte) (ziface.IMessage, error)
• type Message
  • func NewMsgPackage(id uint32, data []byte) *Message
  • func (msg *Message) GetData() []byte
  • func (msg *Message) GetDataLen() uint32
  • func (msg *Message) GetMsgId() uint32
  • func (msg *Message) SetData(data []byte)
  • func (msg *Message) SetDataLen(len uint32)
  • func (msg *Message) SetMsgId(msgId uint32)
• type MsgHandle
  • func NewMsgHandle() *MsgHandle
  • func (mh *MsgHandle) AddRouter(msgId uint32, router ziface.IRouter)
  • func (mh *MsgHandle) DoMsgHandler(request ziface.IRequest)
• type Request
  • func (r *Request) GetConnection() ziface.IConnection
  • func (r *Request) GetData() []byte
  • func (r *Request) GetMsgID() uint32
• type Server
  • func (s *Server) AddRouter(msgId uint32, msghandle ziface.IRouter)
  • func (s *Server) Serve()
  • func (s *Server) Start()
  • func (s *Server) Stop()

Functions

func CallBackToClient

func CallBackToClient(conn *net.TCPConn, data []byte, cnt int) error

============== 定义当前客户端链接的handle api ===========

func NewServer

func NewServer() ziface.IServer

创建一个服务器句柄

Types

type BaseRouter

type BaseRouter struct{}

func (*BaseRouter) Handle

func (br *BaseRouter) Handle(req ziface.IRequest)

这里之所以BaseRouter的方法都为空， 是因为有的Router不希望有PreHandle或PostHandle 所以Router全部继承BaseRouter的好处是，不需要实现PreHandle和PostHandle也可以实例化

type Connection

type Connection struct {
	//当前连接的socket TCP套接字
	Conn *net.TCPConn
	//当前连接的ID 也可以称作为SessionID，ID全局唯一
	ConnID uint32

	//消息管理MsgId和对应处理方法的消息管理模块
	MsgHandler ziface.IMsgHandle

	//告知该链接已经退出/停止的channel
	ExitBuffChan chan bool
	// contains filtered or unexported fields
}

func NewConntion

func NewConntion(conn *net.TCPConn, connID uint32, msgHandler ziface.IMsgHandle) *Connection

创建连接的方法

func (*Connection) GetConnID

func (c *Connection) GetConnID() uint32

获取当前连接ID

func (*Connection) GetTCPConnection

func (c *Connection) GetTCPConnection() *net.TCPConn

从当前连接获取原始的socket TCPConn

func (*Connection) RemoteAddr

func (c *Connection) RemoteAddr() net.Addr

获取远程客户端地址信息

func (*Connection) SendMsg

func (c *Connection) SendMsg(msgId uint32, data []byte) error

func (*Connection) Start

func (c *Connection) Start()

启动连接，让当前连接开始工作

func (*Connection) StartReader

func (c *Connection) StartReader()

处理conn读数据的Goroutine

func (*Connection) Stop

func (c *Connection) Stop()

停止连接，结束当前连接状态M

type DataPack

type DataPack struct{}

封包拆包类实例，暂时不需要成员

func NewDataPack

func NewDataPack() *DataPack

封包拆包实例初始化方法

func (*DataPack) GetHeadLen

func (dp *DataPack) GetHeadLen() uint32

获取包头长度方法

func (*DataPack) Pack

func (dp *DataPack) Pack(msg ziface.IMessage) ([]byte, error)

封包方法(压缩数据)

func (*DataPack) Unpack

func (dp *DataPack) Unpack(binaryData []byte) (ziface.IMessage, error)

拆包方法(解压数据)

type Message

type Message struct {
	Id      uint32 //消息的ID
	DataLen uint32 //消息的长度
	Data    []byte //消息的内容
}

func NewMsgPackage

func NewMsgPackage(id uint32, data []byte) *Message

创建一个Message消息包

func (*Message) GetData

func (msg *Message) GetData() []byte

获取消息内容

func (*Message) GetDataLen

func (msg *Message) GetDataLen() uint32

获取消息数据段长度

func (*Message) GetMsgId

func (msg *Message) GetMsgId() uint32

获取消息ID

func (*Message) SetData

func (msg *Message) SetData(data []byte)

设计消息内容

func (*Message) SetDataLen

func (msg *Message) SetDataLen(len uint32)

设置消息数据段长度

func (*Message) SetMsgId

func (msg *Message) SetMsgId(msgId uint32)

设计消息ID

type MsgHandle

type MsgHandle struct {
	Apis map[uint32]ziface.IRouter //存放每个MsgId 所对应的处理方法的map属性
}

func NewMsgHandle

func NewMsgHandle() *MsgHandle

func (*MsgHandle) AddRouter

func (mh *MsgHandle) AddRouter(msgId uint32, router ziface.IRouter)

为消息添加具体的处理逻辑

func (*MsgHandle) DoMsgHandler

func (mh *MsgHandle) DoMsgHandler(request ziface.IRequest)

马上以非阻塞方式处理消息

type Request

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

func (*Request) GetConnection

func (r *Request) GetConnection() ziface.IConnection

获取请求连接信息

func (*Request) GetData

func (r *Request) GetData() []byte

获取请求消息的数据

func (*Request) GetMsgID

func (r *Request) GetMsgID() uint32

获取请求的消息的ID

type Server

type Server struct {
	//服务器的名称
	Name string
	//tcp4 or other
	IPVersion string
	//服务绑定的IP地址
	IP string
	//服务绑定的端口
	Port int
	// contains filtered or unexported fields
}

func (*Server) AddRouter

func (s *Server) AddRouter(msgId uint32, msghandle ziface.IRouter)

路由功能：给当前服务注册一个路由业务方法，供客户端链接处理使用

func (*Server) Serve

func (s *Server) Serve()

func (*Server) Start

func (s *Server) Start()

开启网络服务

func (*Server) Stop

func (s *Server) Stop()