websocket

Documentation

Index

• Variables
• type FeatureOpts
  • func NewDefaultFeatureOpts() *FeatureOpts
• type WebSocketUpgrader
  • func NewWebSocketUpgrader(upgrader *gws.Upgrader, upgraderConf *WebSocketUpgraderConfig, ...) (*WebSocketUpgrader, error)
  • func (w *WebSocketUpgrader) Stop()
  • func (w *WebSocketUpgrader) Submit(c *gws.Conn) error
  • func (w *WebSocketUpgrader) Upgrade(c *gin.Context) (*gws.Conn, error)
• type WebSocketUpgraderConfig
  • func NewDefaultWebSocketUpgraderConfig() *WebSocketUpgraderConfig

Variables

var (
	UpgraderIsNullError = errors.New("upgrader object is null")
	SocketIsNullError   = errors.New("socket object is null")
)

Types

type FeatureOpts

type FeatureOpts struct {
	EnableMetrics bool `json:"enableMetrics,omitempty" yaml:"enableMetrics,omitempty"` // 开启 metrics 记录
}

func NewDefaultFeatureOpts

func NewDefaultFeatureOpts() *FeatureOpts

type WebSocketUpgrader

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

func NewWebSocketUpgrader

func NewWebSocketUpgrader(upgrader *gws.Upgrader, upgraderConf *WebSocketUpgraderConfig, featureOpts *FeatureOpts) (*WebSocketUpgrader, error)

func (*WebSocketUpgrader) Stop

func (w *WebSocketUpgrader) Stop()

func (*WebSocketUpgrader) Submit

func (w *WebSocketUpgrader) Submit(c *gws.Conn) error

func (*WebSocketUpgrader) Upgrade

func (w *WebSocketUpgrader) Upgrade(c *gin.Context) (*gws.Conn, error)

参考文档： https://github.com/lxzan/gws https://studygolang.com/topics/16189

type WebSocketUpgraderConfig

type WebSocketUpgraderConfig struct {
	Logger *zap.SugaredLogger `json:"-" yaml:"-"`
}

func NewDefaultWebSocketUpgraderConfig

func NewDefaultWebSocketUpgraderConfig() *WebSocketUpgraderConfig