ws

Documentation

Index

• func NewClient(opts ...ClientOption) network.Client
• type CheckOriginFunc
• type ClientOption
  • func WithClientDialUrl(url string) ClientOption
  • func WithClientHandshakeTimeout(handshakeTimeout time.Duration) ClientOption
  • func WithClientHeartbeatInterval(heartbeatInterval time.Duration) ClientOption
• type HeartbeatMechanism
• type Server
  • func NewServer(opts ...ServerOption) Server
• type ServerOption
  • func WithServerCheckOrigin(checkOrigin CheckOriginFunc) ServerOption
  • func WithServerCredentials(certFile, keyFile string) ServerOption
  • func WithServerHandshakeTimeout(handshakeTimeout time.Duration) ServerOption
  • func WithServerHeartbeatInterval(heartbeatInterval time.Duration) ServerOption
  • func WithServerHeartbeatMechanism(heartbeatMechanism HeartbeatMechanism) ServerOption
  • func WithServerHeartbeatWithServerTime(heartbeatWithServerTime bool) ServerOption
  • func WithServerListenAddr(addr string) ServerOption
  • func WithServerMaxConnNum(maxConnNum int) ServerOption
  • func WithServerPath(path string) ServerOption
• type UpgradeHandler

Functions

func NewClient

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

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 WithClientHandshakeTimeout

func WithClientHandshakeTimeout(handshakeTimeout time.Duration) ClientOption

WithClientHandshakeTimeout 设置握手超时时间

func WithClientHeartbeatInterval

func WithClientHeartbeatInterval(heartbeatInterval time.Duration) ClientOption

WithClientHeartbeatInterval 设置心跳间隔时间

type HeartbeatMechanism

type HeartbeatMechanism string

const (
	RespHeartbeat HeartbeatMechanism = "resp" // 响应式心跳
	TickHeartbeat HeartbeatMechanism = "tick" // 主动定时心跳
)

type Server

type Server interface {
	network.Server
	// OnUpgrade 监听HTTP请求升级
	OnUpgrade(handler UpgradeHandler)
}

func NewServer

func NewServer(opts ...ServerOption) Server

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 WithServerHandshakeTimeout

func WithServerHandshakeTimeout(handshakeTimeout time.Duration) ServerOption

WithServerHandshakeTimeout 设置握手超时时间

func WithServerHeartbeatInterval

func WithServerHeartbeatInterval(heartbeatInterval time.Duration) ServerOption

WithServerHeartbeatInterval 设置心跳检测间隔时间

func WithServerHeartbeatMechanism

func WithServerHeartbeatMechanism(heartbeatMechanism HeartbeatMechanism) ServerOption

WithServerHeartbeatMechanism 设置心跳机制

func WithServerHeartbeatWithServerTime

func WithServerHeartbeatWithServerTime(heartbeatWithServerTime bool) ServerOption

WithServerHeartbeatWithServerTime 设置下行心跳是否携带服务器时间

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的连接路径

type UpgradeHandler

type UpgradeHandler func(w http.ResponseWriter, r *http.Request) (allowed bool)