server

package

v0.2.1 Latest Latest Go to latest Published: Aug 29, 2023 License: MIT Imports: 28 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Command struct {
	Instruction Instruction
	Data        string
}

Command from user to the App.

type Instruction int

Instruction from user to the App.

const (
	Pause Instruction = iota
	Resume
	RunTests
)

type Option func(*Server)

Option configures a Server.

func WithLogger(logger *log.Logger) Option

WithLogger configures Server with a logger.

type Server struct {
	Commands chan *Command
	// contains filtered or unexported fields
}

Server for serving web UI and API.

func New(ctx context.Context, rootDir string, opts ...Option) *Server

New Server for serving web UI and API.

func (s *Server) AddResult(r *runner.Result)

AddResult to be served via the API.

Prepends the result to the internal result slice. Slice is trimmed if its length exceeds configured max results.

func (s *Server) Close() error

Close server.

func (s *Server) Reset()

Reset server to initial state.

Sets the state to state.Init, clears results, and closes all long poll subscriptions.

Note: This is mainly used for testing purposes.

func (s *Server) SendNotification(kind, bodyFmt string, args ...any)

SendNotification to display as a toaster message in the web UI.

func (s *Server) Serve(host string, port int) error

Serve requests on host and port.

func (s *Server) SetState(newState state.State)

SetState for server.