network

Documentation

Index

• type Agent
• type Conn
• type ConnSet
• type MsgParser
  • func NewMsgParser() *MsgParser
  • func (p *MsgParser) Read(conn *TCPConn) ([]byte, error)
  • func (p *MsgParser) SetByteOrder(littleEndian bool)
  • func (p *MsgParser) SetMsgLen(lenMsgLen int, minMsgLen uint32, maxMsgLen uint32)
  • func (p *MsgParser) Write(conn *TCPConn, args ...[]byte) error
• type Processor
• type TCPClient
  • func (client *TCPClient) Close()
  • func (client *TCPClient) Start()
• type TCPConn
  • func (tcpConn *TCPConn) Close()
  • func (tcpConn *TCPConn) Destroy()
  • func (tcpConn *TCPConn) LocalAddr() net.Addr
  • func (tcpConn *TCPConn) Read(b []byte) (int, error)
  • func (tcpConn *TCPConn) ReadMsg() ([]byte, error)
  • func (tcpConn *TCPConn) RemoteAddr() net.Addr
  • func (tcpConn *TCPConn) Write(b []byte)
  • func (tcpConn *TCPConn) WriteMsg(args ...[]byte) error
• type TCPServer
  • func (server *TCPServer) Close()
  • func (server *TCPServer) Start()
• type WSClient
  • func (client *WSClient) Close()
  • func (client *WSClient) Start()
• type WSConn
  • func (wsConn *WSConn) Close()
  • func (wsConn *WSConn) Destroy()
  • func (wsConn *WSConn) LocalAddr() net.Addr
  • func (wsConn *WSConn) ReadMsg() ([]byte, error)
  • func (wsConn *WSConn) RemoteAddr() net.Addr
  • func (wsConn *WSConn) WriteMsg(args ...[]byte) error
• type WSHandler
  • func (handler *WSHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type WSServer
  • func (server *WSServer) Close()
  • func (server *WSServer) Start()
• type WebsocketConnSet

Types

type Agent

type Agent interface {
	Run()
	OnClose()
}

type Conn

type Conn interface {
	ReadMsg() ([]byte, error)
	WriteMsg(args ...[]byte) error
	LocalAddr() net.Addr
	RemoteAddr() net.Addr
	Close()
	Destroy()
}

type ConnSet

type ConnSet map[net.Conn]struct{}

type MsgParser

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

-------------- | len | data | --------------

func NewMsgParser

func NewMsgParser() *MsgParser

func (*MsgParser) Read

func (p *MsgParser) Read(conn *TCPConn) ([]byte, error)

goroutine safe

func (*MsgParser) SetByteOrder

func (p *MsgParser) SetByteOrder(littleEndian bool)

It's dangerous to call the method on reading or writing

func (*MsgParser) SetMsgLen

func (p *MsgParser) SetMsgLen(lenMsgLen int, minMsgLen uint32, maxMsgLen uint32)

It's dangerous to call the method on reading or writing

func (*MsgParser) Write

func (p *MsgParser) Write(conn *TCPConn, args ...[]byte) error

goroutine safe

type Processor

type Processor interface {
	// must goroutine safe
	Route(msg interface{}, userData interface{}) error
	// must goroutine safe
	Unmarshal(data []byte) (interface{}, error)
	// must goroutine safe
	Marshal(msg interface{}) ([][]byte, error)
}

type TCPClient

type TCPClient struct {
	sync.Mutex
	Addr            string
	ConnNum         int
	ConnectInterval time.Duration
	PendingWriteNum int
	AutoReconnect   bool
	NewAgent        func(*TCPConn) Agent

	// msg parser
	LenMsgLen    int
	MinMsgLen    uint32
	MaxMsgLen    uint32
	LittleEndian bool
	// contains filtered or unexported fields
}

func (*TCPClient) Close

func (client *TCPClient) Close()

func (*TCPClient) Start

func (client *TCPClient) Start()

type TCPConn

type TCPConn struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*TCPConn) Close

func (tcpConn *TCPConn) Close()

func (*TCPConn) Destroy

func (tcpConn *TCPConn) Destroy()

func (*TCPConn) LocalAddr

func (tcpConn *TCPConn) LocalAddr() net.Addr

func (*TCPConn) Read

func (tcpConn *TCPConn) Read(b []byte) (int, error)

func (*TCPConn) ReadMsg

func (tcpConn *TCPConn) ReadMsg() ([]byte, error)

func (*TCPConn) RemoteAddr

func (tcpConn *TCPConn) RemoteAddr() net.Addr

func (*TCPConn) Write

func (tcpConn *TCPConn) Write(b []byte)

b must not be modified by the others goroutines

func (*TCPConn) WriteMsg

func (tcpConn *TCPConn) WriteMsg(args ...[]byte) error

type TCPServer

type TCPServer struct {
	Addr            string
	MaxConnNum      int
	PendingWriteNum int
	NewAgent        func(*TCPConn) Agent

	// msg parser
	LenMsgLen    int
	MinMsgLen    uint32
	MaxMsgLen    uint32
	LittleEndian bool
	// contains filtered or unexported fields
}

func (*TCPServer) Close

func (server *TCPServer) Close()

func (*TCPServer) Start

func (server *TCPServer) Start()

type WSClient

type WSClient struct {
	sync.Mutex
	Addr             string
	ConnNum          int
	ConnectInterval  time.Duration
	PendingWriteNum  int
	MaxMsgLen        uint32
	HandshakeTimeout time.Duration
	AutoReconnect    bool
	NewAgent         func(*WSConn) Agent
	// contains filtered or unexported fields
}

func (*WSClient) Close

func (client *WSClient) Close()

func (*WSClient) Start

func (client *WSClient) Start()

type WSConn

type WSConn struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*WSConn) Close

func (wsConn *WSConn) Close()

func (*WSConn) Destroy

func (wsConn *WSConn) Destroy()

func (*WSConn) LocalAddr

func (wsConn *WSConn) LocalAddr() net.Addr

func (*WSConn) ReadMsg

func (wsConn *WSConn) ReadMsg() ([]byte, error)

goroutine not safe

func (*WSConn) RemoteAddr

func (wsConn *WSConn) RemoteAddr() net.Addr

func (*WSConn) WriteMsg

func (wsConn *WSConn) WriteMsg(args ...[]byte) error

args must not be modified by the others goroutines

type WSHandler

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

func (*WSHandler) ServeHTTP

func (handler *WSHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type WSServer

type WSServer struct {
	Addr            string
	MaxConnNum      int
	PendingWriteNum int
	MaxMsgLen       uint32
	HTTPTimeout     time.Duration
	CertFile        string
	KeyFile         string
	NewAgent        func(*WSConn) Agent
	// contains filtered or unexported fields
}

func (*WSServer) Close

func (server *WSServer) Close()

func (*WSServer) Start

func (server *WSServer) Start()

type WebsocketConnSet

type WebsocketConnSet map[*websocket.Conn]struct{}