server

Documentation

Index

• type AnalyticsOpter
  • func ProvideAnalyticsOpter(st store.RStore) AnalyticsOpter
• type HeadsUpServer
  • func ProvideHeadsUpServer(store *store.Store, assetServer assets.Server, analytics analytics.Analytics, ...) *HeadsUpServer
  • func (s *HeadsUpServer) HandleAnalytics(w http.ResponseWriter, req *http.Request)
  • func (s *HeadsUpServer) HandleAnalyticsOpt(w http.ResponseWriter, req *http.Request)
  • func (s *HeadsUpServer) HandleResetRestarts(w http.ResponseWriter, req *http.Request)
  • func (s *HeadsUpServer) HandleSail(w http.ResponseWriter, req *http.Request)
  • func (s *HeadsUpServer) Router() http.Handler
  • func (s *HeadsUpServer) ViewJSON(w http.ResponseWriter, req *http.Request)
  • func (s *HeadsUpServer) ViewWebsocket(w http.ResponseWriter, req *http.Request)
• type HeadsUpServerController
  • func ProvideHeadsUpServerController(port model.WebPort, hudServer *HeadsUpServer, assetServer assets.Server, ...) *HeadsUpServerController
  • func (s *HeadsUpServerController) OnChange(ctx context.Context, st store.RStore)
  • func (s *HeadsUpServerController) TearDown(ctx context.Context)
• type WebsocketConn
• type WebsocketSubscriber
  • func NewWebsocketSubscriber(conn WebsocketConn) WebsocketSubscriber
  • func (ws WebsocketSubscriber) OnChange(ctx context.Context, s store.RStore)
  • func (ws WebsocketSubscriber) Stream(ctx context.Context, store *store.Store)
  • func (ws WebsocketSubscriber) TearDown(ctx context.Context)
• type WriteToFileOpter
  • func (o *WriteToFileOpter) SetOptStr(s string) error

Types

type AnalyticsOpter

type AnalyticsOpter interface {
	SetOptStr(s string) error
}

An AnalyticsOpter can record a user's choice (opt-in or opt-out) in re: Tilt recording analytics.

func ProvideAnalyticsOpter

func ProvideAnalyticsOpter(st store.RStore) AnalyticsOpter

type HeadsUpServer

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

func ProvideHeadsUpServer

func ProvideHeadsUpServer(store *store.Store, assetServer assets.Server, analytics analytics.Analytics, sailCli client.SailClient, opter AnalyticsOpter) *HeadsUpServer

func (*HeadsUpServer) HandleAnalytics

func (s *HeadsUpServer) HandleAnalytics(w http.ResponseWriter, req *http.Request)

func (*HeadsUpServer) HandleAnalyticsOpt

func (s *HeadsUpServer) HandleAnalyticsOpt(w http.ResponseWriter, req *http.Request)

func (*HeadsUpServer) HandleResetRestarts

func (s *HeadsUpServer) HandleResetRestarts(w http.ResponseWriter, req *http.Request)

func (*HeadsUpServer) HandleSail

func (s *HeadsUpServer) HandleSail(w http.ResponseWriter, req *http.Request)

func (*HeadsUpServer) Router

func (s *HeadsUpServer) Router() http.Handler

func (*HeadsUpServer) ViewJSON

func (s *HeadsUpServer) ViewJSON(w http.ResponseWriter, req *http.Request)

func (*HeadsUpServer) ViewWebsocket

func (s *HeadsUpServer) ViewWebsocket(w http.ResponseWriter, req *http.Request)

type HeadsUpServerController

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

func ProvideHeadsUpServerController

func ProvideHeadsUpServerController(port model.WebPort, hudServer *HeadsUpServer, assetServer assets.Server, webURL model.WebURL) *HeadsUpServerController

func (*HeadsUpServerController) OnChange

func (s *HeadsUpServerController) OnChange(ctx context.Context, st store.RStore)

func (*HeadsUpServerController) TearDown

func (s *HeadsUpServerController) TearDown(ctx context.Context)

type WebsocketConn

type WebsocketConn interface {
	NextReader() (int, io.Reader, error)
	Close() error
	WriteJSON(v interface{}) error
}

type WebsocketSubscriber

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

func NewWebsocketSubscriber

func NewWebsocketSubscriber(conn WebsocketConn) WebsocketSubscriber

func (WebsocketSubscriber) OnChange

func (ws WebsocketSubscriber) OnChange(ctx context.Context, s store.RStore)

func (WebsocketSubscriber) Stream

func (ws WebsocketSubscriber) Stream(ctx context.Context, store *store.Store)

Should be called exactly once. Consumes messages until the socket closes.

func (WebsocketSubscriber) TearDown

func (ws WebsocketSubscriber) TearDown(ctx context.Context)

type WriteToFileOpter

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

func (*WriteToFileOpter) SetOptStr

func (o *WriteToFileOpter) SetOptStr(s string) error

SetOptStr takes the string of the user's choice in re: sending analytics (should correspond to "opt-in" or "opt-out") and records that choice on disk as dictated by the `analytics` package.