Documentation
¶
Index ¶
- Constants
- type ErrorResponse
- type WebsocketHandler
- type WebsocketMessage
- type WebsocketServer
- func (s *WebsocketServer) RegisterHandler(msgType string, handler WebsocketHandler)
- func (s *WebsocketServer) SendErrorResponse(conn *websocket.Conn, msgID string, msgType string, errorMessage string)
- func (s *WebsocketServer) SendGenericError(conn *websocket.Conn, msgID string, errorMsg string)
- func (s *WebsocketServer) SendResponse(conn *websocket.Conn, msgID string, msgType string, payload interface{})
- func (s *WebsocketServer) Shutdown(timeout time.Duration) error
Constants ¶
View Source
const (
MsgTypeError = "error"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrorResponse ¶
type ErrorResponse struct {
Message string `json:"message"`
}
type WebsocketHandler ¶
type WebsocketHandler = func(msg WebsocketMessage, conn *websocket.Conn)
type WebsocketMessage ¶
type WebsocketMessage struct {
Type string `json:"type"`
ID string `json:"id"`
Payload json.RawMessage `json:"payload"`
Error *ErrorResponse `json:"error,omitempty"`
}
type WebsocketServer ¶
type WebsocketServer struct {
// contains filtered or unexported fields
}
func NewWebsocketServer ¶
func NewWebsocketServer(r chi.Router, logger *slog.Logger) *WebsocketServer
func (*WebsocketServer) RegisterHandler ¶
func (s *WebsocketServer) RegisterHandler(msgType string, handler WebsocketHandler)
func (*WebsocketServer) SendErrorResponse ¶
func (*WebsocketServer) SendGenericError ¶
func (s *WebsocketServer) SendGenericError(conn *websocket.Conn, msgID string, errorMsg string)
func (*WebsocketServer) SendResponse ¶
func (s *WebsocketServer) SendResponse(conn *websocket.Conn, msgID string, msgType string, payload interface{})
Click to show internal directories.
Click to hide internal directories.