webserver

Documentation

Index

• Variables
• func NewRouter(s *Server) *http.ServeMux
• type GameEntry
• type SSEHandler
  • func NewSSEHandler(bufferSize int) *SSEHandler
  • func (h *SSEHandler) Enabled(context.Context, slog.Level) bool
  • func (h *SSEHandler) Handle(ctx context.Context, r slog.Record) error
  • func (h *SSEHandler) Reset()
  • func (h *SSEHandler) Subscribe() ([]string, chan string)
  • func (h *SSEHandler) Unsubscribe(ch chan string)
  • func (h *SSEHandler) WithAttrs([]slog.Attr) slog.Handler
  • func (h *SSEHandler) WithGroup(string) slog.Handler
• type Server
  • func New() (*Server, error)
  • func (s *Server) Stop()

Variables

var DefaultGames = []GameEntry{
	{Name: "Stardew Valley", Port: 24642},
	{Name: "Terraria", Port: 7777},
	{Name: "Factorio", Port: 34197},
	{Name: "Minecraft (Bedrock)", Port: 19132},
	{Name: "Valheim", Port: 2456},
}

DefaultGames is the list of known games shown in the host form dropdown.

Functions

func NewRouter

func NewRouter(s *Server) *http.ServeMux

NewRouter creates an http.ServeMux with all web UI routes registered.

Types

type GameEntry

type GameEntry struct {
	Name string
	Port int
}

GameEntry represents a known game with its default port.

type SSEHandler

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

SSEHandler is a slog.Handler that broadcasts log lines to SSE subscribers. It also maintains a ring buffer for history replay on new connections.

func NewSSEHandler

func NewSSEHandler(bufferSize int) *SSEHandler

NewSSEHandler creates a new SSE log handler with the given buffer size.

func (*SSEHandler) Enabled

func (h *SSEHandler) Enabled(context.Context, slog.Level) bool

func (*SSEHandler) Handle

func (h *SSEHandler) Handle(ctx context.Context, r slog.Record) error

func (*SSEHandler) Reset

func (h *SSEHandler) Reset()

Reset clears the buffer and disconnects all subscribers.

func (*SSEHandler) Subscribe

func (h *SSEHandler) Subscribe() ([]string, chan string)

Subscribe returns buffered history and a channel for new log lines.

func (*SSEHandler) Unsubscribe

func (h *SSEHandler) Unsubscribe(ch chan string)

Unsubscribe removes a subscriber channel.

func (*SSEHandler) WithAttrs

func (h *SSEHandler) WithAttrs([]slog.Attr) slog.Handler

func (*SSEHandler) WithGroup

func (h *SSEHandler) WithGroup(string) slog.Handler

type Server

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

Server is the web UI HTTP server.

func New

func New() (*Server, error)

New creates a new Server and registers all routes.

func (*Server) Stop

func (s *Server) Stop()

Stop gracefully stops any active session and waits for all background goroutines to finish.