ws

package

v0.0.0-rc5 Latest Latest Go to latest Published: Nov 4, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mandarine-io/Backend

Links

Open Source Insights

Documentation ¶

Index ¶

type Handler
- func NewHandler(svc *wsSvc.Service) *Handler
- func (h *Handler) Connect(ctx *gin.Context)
- func (h *Handler) RegisterRoutes(router *gin.Engine, middlewares handler.RouteMiddlewares)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Handler ¶

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

func NewHandler ¶

func NewHandler(svc *wsSvc.Service) *Handler

func (*Handler) Connect ¶

func (h *Handler) Connect(ctx *gin.Context)

Connect godoc

@Id				WsConnect
@Summary		Connect to websocket server
@Description	Request for connect to websocket server. If pool is not full, a new websocket connection is created.
@Tags			Websocket API
@Security		BearerAuth
@Success		101
@Failure		400		{object}	dto.ErrorResponse
@Failure		401		{object}	dto.ErrorResponse
@Failure		503		{object}	dto.ErrorResponse
@Router			/ws [get]

func (*Handler) RegisterRoutes ¶

func (h *Handler) RegisterRoutes(router *gin.Engine, middlewares handler.RouteMiddlewares)

Source Files ¶

View all Source files

handler.go

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