server

README

Server

Code which runs the server.

Documentation

Overview

Package server - Main subsystem wrangler

Index

• type Server
  • func (s *Server) CloseLogfile() error
  • func (s *Server) SL() *slog.Logger
  • func (s *Server) Start() error
  • func (s *Server) Stop(defErr error) error
  • func (s *Server) Wait() error

Types

type Server

type Server struct {
	Dir   string
	Debug bool

	/* Listen addresses. */
	HTTPAddr  string
	HTTPSAddr string

	/* TLS Config.  If HTTPSAddr is set and there's no domains set, no
	Let's Encrypt provisioning will take place and a self-signed cert
	will be used for all HTTP requests. */
	LEDomainWhitelist []string
	SSDomainWhitelist []string
	LEStaging         bool
	LEEmail           string

	/* Other config. */
	ExfilMax uint64

	/* Only for testing. */
	TestLogOutput io.Writer
	// contains filtered or unexported fields
}

Server implements the server side of Plonk. Before starting, its public fields should be populated. Start should be used to start it and then Wait to wait for something bad to happen. Once Start is called, Server's fields should be treated as read-only.

func (*Server) CloseLogfile

func (s *Server) CloseLogfile() error

CloseLogfile closes the logfile. This is used during testing.

func (*Server) SL

func (s *Server) SL() *slog.Logger

SL returns s's logger.

func (*Server) Start

func (s *Server) Start() error

Start starts the server.

func (*Server) Stop

func (s *Server) Stop(defErr error) error

Stop stops the server. It returns the same value as wait. If no other error is to be returned, defErr is returned by both Wait and Stop.

func (*Server) Wait

func (s *Server) Wait() error

Wait waits for a fatal error or nil on clean shutdown with Stop.