grapeWSNetv2

Documentation

Overview

Websocket v2 Network version 2.0 beta by koangel email: jackliu100@gmail.com 2020/04/02

Index

• Constants
• Variables
• type WSConn
  • func NewDial(wn *WSNetwork, addr, sOrigin string, UData interface{}) (conn *WSConn, err error)
  • func NewWConn(wn *WSNetwork, Conn net.Conn, UData interface{}) *WSConn
  • func (c *WSConn) Close()
  • func (c *WSConn) GetConn() net.Conn
  • func (c *WSConn) GetNetConn() net.Conn
  • func (c *WSConn) GetUserData() interface{}
  • func (c *WSConn) InitData()
  • func (c *WSConn) RemoteAddr() string
  • func (c *WSConn) RemoveData()
  • func (c *WSConn) Send(data []byte) int
  • func (c *WSConn) SendDirect(data []byte) int
  • func (c *WSConn) SendPak(val interface{}) int
  • func (c *WSConn) SendPakDirect(val interface{}) int
  • func (c *WSConn) SetReadTimeout(t time.Duration)
  • func (c *WSConn) SetUserData(user interface{})
  • func (c *WSConn) SetWriteTimeout(t time.Duration)
• type WSNetwork
  • func NetEmptyWS(Origin, wPath string) *WSNetwork
  • func NewWebsocket(addr, Origin, wPath string) *WSNetwork
  • func (c *WSNetwork) CheckOrigin(key, value string) bool
  • func (c *WSNetwork) CheckPath(url string) bool
  • func (c *WSNetwork) Dial(addr string) (conn *WSConn, err error)
  • func (c *WSNetwork) RemoveSession(sessionId string)
  • func (c *WSNetwork) Runnable()
  • func (c *WSNetwork) SetBinaryMessage()
  • func (c *WSNetwork) SetTextMessage()

Constants

const (
	ReadWaitPing = 120 * time.Second
	WriteTicker  = 2 * time.Minute
)

const (
	BinaryMsg = ws.OpBinary
	TextMsg   = ws.OpText
)

Variables

var (
	HandlerProc = 1
)

Types

type WSConn

type WSConn struct {
	cm.Conn

	WConn    net.Conn
	UserData interface{} // 用户对象
	LastPing time.Time

	CryptKey []byte

	State ws.State

	IsClosed int32

	RMData sync.Once
	// contains filtered or unexported fields
}

func NewDial

func NewDial(wn *WSNetwork, addr, sOrigin string, UData interface{}) (conn *WSConn, err error)

func NewWConn

func NewWConn(wn *WSNetwork, Conn net.Conn, UData interface{}) *WSConn

///////////////////////////////////////////// 新建WS

func (*WSConn) Close

func (c *WSConn) Close()

func (*WSConn) GetConn

func (c *WSConn) GetConn() net.Conn

func (*WSConn) GetNetConn

func (c *WSConn) GetNetConn() net.Conn

func (*WSConn) GetUserData

func (c *WSConn) GetUserData() interface{}

func (*WSConn) InitData

func (c *WSConn) InitData()

func (*WSConn) RemoteAddr

func (c *WSConn) RemoteAddr() string

func (*WSConn) RemoveData

func (c *WSConn) RemoveData()

func (*WSConn) Send

func (c *WSConn) Send(data []byte) int

func (*WSConn) SendDirect

func (c *WSConn) SendDirect(data []byte) int

func (*WSConn) SendPak

func (c *WSConn) SendPak(val interface{}) int

func (*WSConn) SendPakDirect

func (c *WSConn) SendPakDirect(val interface{}) int

func (*WSConn) SetReadTimeout

func (c *WSConn) SetReadTimeout(t time.Duration)

func (*WSConn) SetUserData

func (c *WSConn) SetUserData(user interface{})

//////////////////////////////////////////// 成员函数

func (*WSConn) SetWriteTimeout

func (c *WSConn) SetWriteTimeout(t time.Duration)

type WSNetwork

type WSNetwork struct {
	Origin string

	ChkOrigin bool

	NetCM *cm.ConnManager

	/// 所有的callBack函数
	// 创建用户DATA
	CreateUserData func() interface{}

	// 通知连接
	OnAccept func(conn *WSConn)
	// 数据包进入
	OnHandler func(conn *WSConn, ownerPak []byte)
	// 连接关闭
	OnClose func(conn *WSConn)
	// 连接成功
	OnConnected func(conn *WSConn)

	// 连接安全性检测 server only
	OnHeader  func(key, value string) error
	OnRequest func(url string) error

	// 打包以及加密行为
	Package   func(val interface{}) (data []byte, err error)
	Unpackage func(conn *WSConn, spak *stream.BufferIO) (data [][]byte, err error)

	// 输出panic数据
	Panic func(conn *WSConn, src string)

	Encrypt func(data, key []byte) []byte
	Decrypt func(data, key []byte) []byte

	HttpHome func(w http.ResponseWriter, r *http.Request)

	MsgType ws.OpCode
	// contains filtered or unexported fields
}

func NetEmptyWS

func NetEmptyWS(Origin, wPath string) *WSNetwork

//////////////////////////////////// 新建函数

func NewWebsocket

func NewWebsocket(addr, Origin, wPath string) *WSNetwork

func (*WSNetwork) CheckOrigin

func (c *WSNetwork) CheckOrigin(key, value string) bool

func (*WSNetwork) CheckPath

func (c *WSNetwork) CheckPath(url string) bool

//////////////////////////////////// 成员函数

func (*WSNetwork) Dial

func (c *WSNetwork) Dial(addr string) (conn *WSConn, err error)

func (*WSNetwork) RemoveSession

func (c *WSNetwork) RemoveSession(sessionId string)

func (*WSNetwork) Runnable

func (c *WSNetwork) Runnable()

func (*WSNetwork) SetBinaryMessage

func (c *WSNetwork) SetBinaryMessage()

func (*WSNetwork) SetTextMessage

func (c *WSNetwork) SetTextMessage()