ginwebsocket

Documentation

Index

• type Router
  • func NewRouter(path, configPath string) *Router
  • func (r *Router) GetClientManager() *websocket.ClientManager
  • func (r *Router) OnTextMessageController(scene string, controller websocket.TextMessageController)
  • func (r *Router) Register(rg *gin.RouterGroup)
  • func (r *Router) SetAuthorizationFunc(...)
  • func (r *Router) SetBeforeFunc(...)
  • func (r *Router) SetClientCloseFunc(f func(context.Context, string))

Types

type Router

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

func NewRouter

func NewRouter(path, configPath string) *Router

func (*Router) GetClientManager

func (r *Router) GetClientManager() *websocket.ClientManager

func (*Router) OnTextMessageController

func (r *Router) OnTextMessageController(scene string, controller websocket.TextMessageController)

func (*Router) Register

func (r *Router) Register(rg *gin.RouterGroup)

Register 将 WebSocket 路由注册到指定 RouterGroup，供 HTTPHandler 使用。

func (*Router) SetAuthorizationFunc

func (r *Router) SetAuthorizationFunc(f func(ctx context.Context, r *http.Request, w http.ResponseWriter) (returnCtx context.Context, isAuthorized bool, userId int64))

func (*Router) SetBeforeFunc

func (r *Router) SetBeforeFunc(f func(ctx context.Context, r *http.Request, w http.ResponseWriter) (returnCtx context.Context, isAuthorized bool, userId int64))

func (*Router) SetClientCloseFunc

func (r *Router) SetClientCloseFunc(f func(context.Context, string))