dash

Documentation

Overview

Package dash serves the Encore Developer Dashboard.

Index

• type ListEncoderExtension
  • func NewListEncoderExtension() *ListEncoderExtension
  • func (e *ListEncoderExtension) DecorateEncoder(typ reflect2.Type, encoder jsoniter.ValEncoder) jsoniter.ValEncoder
• type Server
  • func NewServer(appsMgr *apps.Manager, runMgr *run.Manager, tr trace2.Store, dashPort int) *Server
  • func (s *Server) OnError(r *run.Run, err *errlist.List)
  • func (s *Server) OnReload(r *run.Run)
  • func (s *Server) OnStart(r *run.Run)
  • func (s *Server) OnStderr(r *run.Run, out []byte)
  • func (s *Server) OnStdout(r *run.Run, out []byte)
  • func (s *Server) OnStop(r *run.Run)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (s *Server) WebSocket(w http.ResponseWriter, req *http.Request)

Types

type ListEncoderExtension

type ListEncoderExtension struct {
	jsoniter.DummyExtension
}

func NewListEncoderExtension

func NewListEncoderExtension() *ListEncoderExtension

func (*ListEncoderExtension) DecorateEncoder

func (e *ListEncoderExtension) DecorateEncoder(typ reflect2.Type, encoder jsoniter.ValEncoder) jsoniter.ValEncoder

type Server

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

Server is the http.Handler for serving the developer dashboard.

func NewServer

func NewServer(appsMgr *apps.Manager, runMgr *run.Manager, tr trace2.Store, dashPort int) *Server

NewServer starts a new server and returns it.

func (*Server) OnError

func (s *Server) OnError(r *run.Run, err *errlist.List)

func (*Server) OnReload

func (s *Server) OnReload(r *run.Run)

OnReload notifies active websocket clients about the reloaded run.

func (*Server) OnStart

func (s *Server) OnStart(r *run.Run)

OnStart notifies active websocket clients about the started run.

func (*Server) OnStderr

func (s *Server) OnStderr(r *run.Run, out []byte)

OnStderr forwards the output to active websocket clients.

func (*Server) OnStdout

func (s *Server) OnStdout(r *run.Run, out []byte)

OnStdout forwards the output to active websocket clients.

func (*Server) OnStop

func (s *Server) OnStop(r *run.Run)

OnStop notifies active websocket clients about the stopped run.

func (*Server) ServeHTTP

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

func (*Server) WebSocket

func (s *Server) WebSocket(w http.ResponseWriter, req *http.Request)

WebSocket serves the jsonrpc2 API over WebSocket.