api

Documentation

Index

• type Controller
  • func New(ctx context.Context, pbService pubsub.Server) Controller
  • func NewWithServiceAndWSUpgrader(ctx context.Context, service Service, upgrader WSUpgrader) Controller
• type Error
• type Service
  • func NewService(ctx context.Context, pbService pubsub.Server) Service
• type WSUpgrader
• type WriteMessageCloser

Types

type Controller

type Controller interface {
	RegisterRoutes(router *gin.Engine)
}

Controller is the websocket pub-sub controller

func New

func New(ctx context.Context, pbService pubsub.Server) Controller

func NewWithServiceAndWSUpgrader

func NewWithServiceAndWSUpgrader(ctx context.Context, service Service, upgrader WSUpgrader) Controller

NewWithOptions create a new controller with options

type Error

type Error struct {
	Error string `json:"error"`
}

Error ...

type Service

type Service interface {
	Websocket(string, WriteMessageCloser) (int, error)
	Callback(p internal.Payload)
}

func NewService

func NewService(ctx context.Context, pbService pubsub.Server) Service

type WSUpgrader

type WSUpgrader interface {
	Upgrade(w http.ResponseWriter, r *http.Request) (WriteMessageCloser, error)
}

type WriteMessageCloser

type WriteMessageCloser interface {
	io.Closer
	WriteMessage(int, []byte) error
}