ws

Documentation

Index

• Constants
• func NewServer(serverID string, opts ...ServerOption) inet.SocketServer
• type CheckOriginFunc
• type ServerOption
  • func WithServerCheckOrigin(checkOrigin CheckOriginFunc) ServerOption
  • func WithServerCredentials(certFile, keyFile string) ServerOption
  • func WithServerEnableHeartbeatCheck(enable bool) ServerOption
  • func WithServerHandshakeTimeout(handshakeTimeout time.Duration) ServerOption
  • func WithServerHeartbeatCheckInterval(heartbeatCheckInterval time.Duration) ServerOption
  • func WithServerListenAddr(addr string) ServerOption
  • func WithServerMaxConnNum(maxConnNum int) ServerOption
  • func WithServerMaxMsgLen(maxMsgLen int) ServerOption
  • func WithServerPath(path string) ServerOption

Constants

const (
	TextMessage   = websocket.TextMessage
	BinaryMessage = websocket.BinaryMessage
)

Functions

func NewServer

func NewServer(serverID string, opts ...ServerOption) inet.SocketServer

Types

type CheckOriginFunc

type CheckOriginFunc func(r *http.Request) bool

type ServerOption

type ServerOption func(o *serverOptions)

func WithServerCheckOrigin

func WithServerCheckOrigin(checkOrigin CheckOriginFunc) ServerOption

WithServerCheckOrigin 设置Websocket跨域检测函数

func WithServerCredentials

func WithServerCredentials(certFile, keyFile string) ServerOption

WithServerCredentials 设置证书和秘钥

func WithServerEnableHeartbeatCheck

func WithServerEnableHeartbeatCheck(enable bool) ServerOption

WithServerEnableHeartbeatCheck 是否启用心跳检测

func WithServerHandshakeTimeout

func WithServerHandshakeTimeout(handshakeTimeout time.Duration) ServerOption

WithServerHandshakeTimeout 设置握手超时时间

func WithServerHeartbeatCheckInterval

func WithServerHeartbeatCheckInterval(heartbeatCheckInterval time.Duration) ServerOption

WithServerHeartbeatCheckInterval 设置心跳检测间隔时间

func WithServerListenAddr

func WithServerListenAddr(addr string) ServerOption

WithServerListenAddr 设置监听地址

func WithServerMaxConnNum

func WithServerMaxConnNum(maxConnNum int) ServerOption

WithServerMaxConnNum 设置连接的最大连接数

func WithServerMaxMsgLen

func WithServerMaxMsgLen(maxMsgLen int) ServerOption

WithServerMaxMsgLen 设置最大包体长度

func WithServerPath

func WithServerPath(path string) ServerOption

WithServerPath 设置Websocket的连接路径