Documentation
¶
Index ¶
- func WsHandler(opts *ws2.ExtensionOpts) fiber.Handler
- type CloseEvent
- type DoneChan
- type EventType
- type ManagerMetrics
- type SocketConnection
- type SocketEvent
- type SocketManager
- func (manager *SocketManager) Add(roomId string, id string, writer WriterChan, done DoneChan)
- func (manager *SocketManager) BroadcastText(roomId string, message string, predicate func(conn SocketConnection) bool)
- func (manager *SocketManager) Close()
- func (manager *SocketManager) CloseWithMessage(id string, message string)
- func (manager *SocketManager) Disconnect(id string)
- func (manager *SocketManager) ForEachSocket(roomId string, cb func(conn SocketConnection))
- func (manager *SocketManager) Get(id string) *SocketConnection
- func (manager *SocketManager) Listen(listener chan SocketEvent)
- func (manager *SocketManager) Metrics() ManagerMetrics
- func (manager *SocketManager) OnClose(id string)
- func (manager *SocketManager) OnMessage(id string, message map[string]any)
- func (manager *SocketManager) Ping(id string) bool
- func (manager *SocketManager) RunIntervalWithSocket(socketId string, interval time.Duration, cb func() bool)
- func (manager *SocketManager) SendHtml(id string, message string) bool
- func (manager *SocketManager) SendText(id string, message string) bool
- func (manager *SocketManager) StartMetrics()
- type WriterChan
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WsHandler ¶
func WsHandler(opts *ws2.ExtensionOpts) fiber.Handler
WsHandler returns a Fiber handler that upgrades connections to WebSocket using gobwas/ws for the protocol framing.
Because Fiber is built on fasthttp (which does not expose a standard net/http ResponseWriter with Hijack support), we use fasthttp's native Hijack mechanism:
- Read the Sec-WebSocket-Key from the request.
- Tell fasthttp not to send its own response (HijackSetNoResponse).
- Register a HijackHandler that receives the raw net.Conn.
- Inside the HijackHandler, write the 101 Switching Protocols response manually (RFC 6455 opening handshake).
- Run the read/write loops with gobwas/ws/wsutil on the hijacked conn.
Types ¶
type CloseEvent ¶
type ManagerMetrics ¶
type SocketConnection ¶
type SocketConnection struct {
Id string
RoomId string
Done DoneChan
Writer WriterChan
}
type SocketEvent ¶
type SocketManager ¶
type SocketManager struct {
// contains filtered or unexported fields
}
func NewSocketManager ¶
func NewSocketManager(opts *opts.ExtensionOpts) *SocketManager
func SocketManagerFromCtx ¶
func SocketManagerFromCtx(ctx *h.RequestContext) *SocketManager
func (*SocketManager) Add ¶
func (manager *SocketManager) Add(roomId string, id string, writer WriterChan, done DoneChan)
func (*SocketManager) BroadcastText ¶
func (manager *SocketManager) BroadcastText(roomId string, message string, predicate func(conn SocketConnection) bool)
func (*SocketManager) Close ¶
func (manager *SocketManager) Close()
Close stops the background metrics goroutine. Call this during graceful shutdown to avoid leaking the goroutine started by StartMetrics.
func (*SocketManager) CloseWithMessage ¶
func (manager *SocketManager) CloseWithMessage(id string, message string)
func (*SocketManager) Disconnect ¶
func (manager *SocketManager) Disconnect(id string)
func (*SocketManager) ForEachSocket ¶
func (manager *SocketManager) ForEachSocket(roomId string, cb func(conn SocketConnection))
func (*SocketManager) Get ¶
func (manager *SocketManager) Get(id string) *SocketConnection
func (*SocketManager) Listen ¶
func (manager *SocketManager) Listen(listener chan SocketEvent)
func (*SocketManager) Metrics ¶
func (manager *SocketManager) Metrics() ManagerMetrics
func (*SocketManager) OnClose ¶
func (manager *SocketManager) OnClose(id string)
func (*SocketManager) OnMessage ¶
func (manager *SocketManager) OnMessage(id string, message map[string]any)
func (*SocketManager) Ping ¶
func (manager *SocketManager) Ping(id string) bool
func (*SocketManager) RunIntervalWithSocket ¶
func (manager *SocketManager) RunIntervalWithSocket(socketId string, interval time.Duration, cb func() bool)
func (*SocketManager) SendHtml ¶
func (manager *SocketManager) SendHtml(id string, message string) bool
func (*SocketManager) SendText ¶
func (manager *SocketManager) SendText(id string, message string) bool
func (*SocketManager) StartMetrics ¶
func (manager *SocketManager) StartMetrics()
type WriterChan ¶
type WriterChan chan string
Click to show internal directories.
Click to hide internal directories.