live

package

v0.1.0 Latest Latest Go to latest Published: Sep 13, 2022 License: MIT Imports: 12 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

Package live broadcasts the moves in a web view.

This section is empty.

This section is empty.

This section is empty.

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

View represents a live web view.

func New(static fs.FS, port int, logger *log.Logger) (*View, chan error, error)

New creates a new live view.

func (v *View) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements the http.Handler interface.

func (v *View) Shutdown() error

Shutdown shuts down the live view gracefully.

func (v *View) Update(move *chess.Move, position *chess.Position) error

Update updates the live view with the latest move and position.

func (v *View) Wait(ctx context.Context)

Wait awaits that the user confirms the view is live.