websocket

package module

Go to main page

Versions in this module

v0

v0.2.2

Dec 28, 2025

Changes in this version

+ func TokenLoginHandler(c *Context) *jsonrpc.Response

type Context

+ func (c *Context) LoginInfo() *LoginInfo

+ func (c *Context) SetLoginInfo(tokenInfo *TokenInfo, platform string)

+ type LoginInfo struct

+ Platform string

+ TokenInfo *TokenInfo

v0.2.1

Dec 12, 2025

Changes in this version

type Client

+ func (c *Client) GetPlatform() string

+ func (c *Client) GetUserID() string

type Hub

+ func (h *Hub) Done() <-chan struct{}

v0.2.0

Dec 12, 2025

Changes in this version

type Hub

+ func (h *Hub) CanAcceptConnection() bool

+ func (h *Hub) CanUserConnect(userID string) bool

+ func (h *Hub) Metrics() *Metrics

+ func (h *Hub) TotalConnections() int

+ func (h *Hub) UserConnectionCount(userID string) int

type HubConfig

+ MaxConnections int

+ MaxConnsPerUser int

+ func (c *HubConfig) Validate() error

type HubOption

+ func WithMetrics(m *Metrics) HubOption

+ type Metrics struct

+ AnonymousConns prometheus.Gauge

+ AuthenticatedConns prometheus.Gauge

+ BroadcastsSent prometheus.Counter

+ ConnectionsCurrent prometheus.Gauge

+ ConnectionsTotal prometheus.Counter

+ ErrorsTotal *prometheus.CounterVec

+ MessagesReceived prometheus.Counter

+ MessagesSent prometheus.Counter

+ SubscriptionsTotal prometheus.Counter

+ TopicsTotal prometheus.Gauge

+ func NewMetrics(namespace, subsystem string) *Metrics

+ func (m *Metrics) Collectors() []prometheus.Collector

+ func (m *Metrics) MustRegister(reg prometheus.Registerer)

+ func (m *Metrics) Register(reg prometheus.Registerer) error

v0.1.0

Dec 12, 2025

Changes in this version

+ const PlatformAndroid

+ const PlatformDesktop

+ const PlatformH5

+ const PlatformIOS

+ const PlatformMiniApp

+ const PlatformWeb

+ var FromError = errors.FromError

+ var NewError = errors.New

+ func HeartbeatHandler(c *Context) *jsonrpc.Response

+ func IsValidPlatform(p string) bool

+ func RequestID(ctx context.Context) string

+ func SubscribeHandler(c *Context) *jsonrpc.Response

+ func UnsubscribeHandler(c *Context) *jsonrpc.Response

+ func UserID(ctx context.Context) string

+ func WithRequestID(ctx context.Context, requestID string) context.Context

+ func WithUserID(ctx context.Context, userID string) context.Context

+ type Client struct

+ Addr string

+ FirstTime int64

+ HeartbeatTime int64

+ ID string

+ LoginTime int64

+ Platform string

+ Send chan []byte

+ TokenExpiresAt int64

+ UserID string

+ func NewClient(hub *Hub, conn *websocket.Conn, ctx context.Context, opts ...ClientOption) *Client

+ func (c *Client) Heartbeat(currentTime int64)

+ func (c *Client) IsAuthenticated() bool

+ func (c *Client) IsHeartbeatTimeout(currentTime int64) bool

+ func (c *Client) Login(platform, userID string, loginTime int64)

+ func (c *Client) NotifyLogin(userID, platform string, tokenExpiresAt int64)

+ func (c *Client) ParseToken(token string) (*TokenInfo, error)

+ func (c *Client) ReadPump()

+ func (c *Client) SendJSON(v any)

+ func (c *Client) UpdateContext(userID string)

+ func (c *Client) WritePump()

+ type ClientDisconnectCallback func(client *Client)

+ type ClientOption func(*Client)

+ func WithContextUpdater(updater ContextUpdater) ClientOption

+ func WithRouter(r *Router) ClientOption

+ func WithTokenParser(parser TokenParser) ClientOption

+ type Context struct

+ Client *Client

+ Method string

+ Request *jsonrpc.Request

+ StartTime time.Time

+ func (c *Context) BindParams(v any) error

+ func (c *Context) BindValidate(v any) error

+ func (c *Context) Error(err error) *jsonrpc.Response

+ func (c *Context) JSON(data any) *jsonrpc.Response

+ func (c *Context) RequestID() string

+ func (c *Context) UserID() string

+ type ContextUpdater func(ctx context.Context, userID string) context.Context

+ type Error = errors.Error

+ type Group struct

+ func (g *Group) Handle(method string, handler Handler, middlewares ...Middleware)

+ func (g *Group) Use(middlewares ...Middleware) *Group

+ type Handler func(*Context) *jsonrpc.Response

+ type Hub struct

+ Broadcast chan []byte

+ Login chan *LoginEvent

+ Register chan *Client

+ Subscribe chan *SubscribeEvent

+ Unregister chan *Client

+ Unsubscribe chan *UnsubscribeEvent

+ func NewHub(opts ...HubOption) *Hub

+ func NewHubWithConfig(cfg *HubConfig, opts ...HubOption) *Hub

+ func (h *Hub) AnonymousCount() int

+ func (h *Hub) ClientCount() int

+ func (h *Hub) GetClient(clientID string) *Client

+ func (h *Hub) GetClientsByUser(userID string) []*Client

+ func (h *Hub) GetUserClient(platform, userID string) *Client

+ func (h *Hub) KickClient(clientID string, reason string) bool

+ func (h *Hub) KickUser(userID string, reason string) int

+ func (h *Hub) PushToTopic(topic, method string, data any)

+ func (h *Hub) PushToUser(platform, userID, method string, data any)

+ func (h *Hub) PushToUserAllPlatforms(userID, method string, data any)

+ func (h *Hub) Run(ctx context.Context)

+ func (h *Hub) Stats() *HubStats

+ func (h *Hub) TopicCount() int

+ func (h *Hub) UserCount() int

+ type HubConfig struct

+ AnonymousCleanup time.Duration

+ AnonymousTimeout time.Duration

+ HeartbeatCleanup time.Duration

+ HeartbeatTimeout time.Duration

+ MaxMessageSize int64

+ PingPeriod time.Duration

+ PongWait time.Duration

+ WriteWait time.Duration

+ func DefaultHubConfig() *HubConfig

+ type HubOption func(*Hub)

+ func WithClientDisconnectCallback(cb ClientDisconnectCallback) HubOption

+ func WithLogger(l Logger) HubOption

+ type HubStats struct

+ AnonymousConns int64

+ AuthenticatedConns int64

+ ConnectionsByPlatform map[string]int

+ TotalConnections int64

+ type Logger interface

+ Debugw func(msg string, keysAndValues ...any)

+ Errorw func(msg string, keysAndValues ...any)

+ Infow func(msg string, keysAndValues ...any)

+ Warnw func(msg string, keysAndValues ...any)

+ WithContext func(ctx context.Context) Logger

+ func NopLogger() Logger

+ type LoginEvent struct

+ Client *Client

+ Platform string

+ TokenExpiresAt int64

+ UserID string

+ type Middleware func(Handler) Handler

+ func Chain(middlewares ...Middleware) Middleware

+ type Router struct

+ func NewRouter() *Router

+ func (r *Router) Dispatch(c *Context) *jsonrpc.Response

+ func (r *Router) Group(middlewares ...Middleware) *Group

+ func (r *Router) Handle(method string, handler Handler, middlewares ...Middleware)

+ func (r *Router) Methods() []string

+ func (r *Router) Use(middlewares ...Middleware) *Router

+ type SubscribeEvent struct

+ Client *Client

+ Result chan []string

+ Topics []string

+ type TokenInfo struct

+ ExpiresAt int64

+ UserID string

+ type TokenParser func(token string) (*TokenInfo, error)

+ type UnsubscribeEvent struct

+ Client *Client

+ Topics []string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL