docapi

Documentation

Index

• Variables
• type Event
• type Hub
  • func NewHub() *Hub
  • func (h *Hub) Publish(event Event)
  • func (h *Hub) Subscribe(collection string) (string, <-chan Event)
  • func (h *Hub) Unsubscribe(id string)
• type Options
• type Server
  • func New(opts Options) *Server
  • func (s *Server) ListenAndServe() error
  • func (s *Server) Mount(mux *http.ServeMux)
  • func (s *Server) Shutdown(ctx context.Context) error

Variables

var ErrClosed = errors.New("server closed")

Types

type Event

type Event struct {
	SubID      string         `json:"subId,omitempty"`
	Event      string         `json:"event"`
	Collection string         `json:"collection"`
	ID         string         `json:"id"`
	Doc        map[string]any `json:"doc,omitempty"`
}

type Hub

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

func NewHub

func NewHub() *Hub

func (*Hub) Publish

func (h *Hub) Publish(event Event)

func (*Hub) Subscribe

func (h *Hub) Subscribe(collection string) (string, <-chan Event)

func (*Hub) Unsubscribe

func (h *Hub) Unsubscribe(id string)

type Options

type Options struct {
	Addr               string
	Token              string
	MaxBodyBytes       int64
	WSEnabled          bool
	AllowedIPs         []string
	IPCheck            bool
	CORSEnabled        bool
	CORSOrigins        []string
	RateLimitEnabled   bool
	RateLimitRPS       int
	RateLimitBurst     int
	WSMaxMessageBytes  int64
	WSIdleTimeout      time.Duration
	WSMaxSubscriptions int
	Store              docstore.Store
	Logger             *zap.Logger
}

type Server

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

func New

func New(opts Options) *Server

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

func (*Server) Mount

func (s *Server) Mount(mux *http.ServeMux)

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error