ws

Documentation

Index

• Constants
• func NewClient(opts ...ClientOption) network.Client
• func NewServer(opts ...ServerOption) network.Server
• type CheckOriginFunc
• type ClientOption
  • func WithClientDialUrl(url string) ClientOption
  • func WithClientEnableHeartbeat(enable bool) ClientOption
  • func WithClientHandshakeTimeout(handshakeTimeout time.Duration) ClientOption
  • func WithClientHeartbeatInterval(heartbeatInterval time.Duration) ClientOption
  • func WithClientMaxMsgLen(maxMsgLen int) ClientOption
• 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 WithServerPath(path string) ServerOption

Constants

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

Functions

func NewClient

func NewClient(opts ...ClientOption) network.Client

func NewServer

func NewServer(opts ...ServerOption) network.Server

Types

type CheckOriginFunc

type CheckOriginFunc func(r *http.Request) bool

type ClientOption

type ClientOption func(o *clientOptions)

func WithClientDialUrl

func WithClientDialUrl(url string) ClientOption

WithClientDialUrl 设置拨号链接

func WithClientEnableHeartbeat

func WithClientEnableHeartbeat(enable bool) ClientOption

WithClientEnableHeartbeat 设置是否启用心跳间隔时间

func WithClientHandshakeTimeout

func WithClientHandshakeTimeout(handshakeTimeout time.Duration) ClientOption

WithClientHandshakeTimeout 设置握手超时时间

func WithClientHeartbeatInterval

func WithClientHeartbeatInterval(heartbeatInterval time.Duration) ClientOption

WithClientHeartbeatInterval 设置心跳间隔时间

func WithClientMaxMsgLen

func WithClientMaxMsgLen(maxMsgLen int) ClientOption

WithClientMaxMsgLen 设置消息最大长度

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 WithServerPath

func WithServerPath(path string) ServerOption

WithServerPath 设置Websocket的连接路径