websocket

Documentation

Index

• type Config
• type Limitation
• type Server
  • func New(cfg Config, h *repository.Handler, m *metrics.Metrics, r *redis.Redis, ...) (*Server, error)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Start() error
  • func (s *Server) Stop() error

Types

type Config

type Config struct {
	Bind       string `yaml:"bind"`
	Port       uint16 `yaml:"port"`
	URL        *url.URL
	Limitation *Limitation
}

type Limitation

type Limitation struct {
	MaxMessageLength    int32 // todo?.
	MaxSubscriptions    int32
	MaxSubidLength      int32
	MinPowDifficulty    int32
	AuthRequired        bool
	PaymentRequired     bool
	RestrictedWrites    bool
	MaxEventTags        int32
	MaxContentLength    int32
	CreatedAtLowerLimit int64
	CreatedAtUpperLimit int64
}

type Server

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

Server represents a websocket serer which keeps track of client connections and handle them.

func New

func New(cfg Config, h *repository.Handler, m *metrics.Metrics,
	r *redis.Redis, grpc grpcclient.IClient,
) (*Server, error)

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

handleWS is WebSocket handler.

func (*Server) Start

func (s *Server) Start() error

Start starts a new server instance.

func (*Server) Stop

func (s *Server) Stop() error

Stop shutdowns the server gracefully.