server

package

v1.4.0 Latest Latest Go to latest Published: Jul 10, 2026 License: MIT Imports: 20 Imported by: 0

Details

Package server represents the webserver that powers S&D.

This section is empty.

This section is empty.

func DefaultSettings() snd.Settings

type Option func(s *Server) error

Option represent an configuration option for the server.

func WithAdditionalRoutes(routes ...func(e *echo.Group)) Option

WithAdditionalRoutes adds additional routes to the server.

func WithDataDir(dir string) Option

WithDataDir sets the data directory of the Server.

func WithDebug(value bool) Option

WithDebug sets the debug state of the Server.

func WithDefaultSettings(settings snd.Settings) Option

WithDefaultSettings overrides the settings created for a new user database.

func WithFilePicker(filePicker rpc.FilePicker) Option

func WithPrinter(printer printing.Printer) Option

WithPrinter registers a printer in the Server.

type Server struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Server represents an instance of the S&D server.

func New(db database.Database, options ...Option) (*Server, error)

New creates a new instance of the S&D server.

func (s *Server) Close() error

Close closes the server and all its connections.

func (s *Server) Start(bindAddr string) error

Start starts the server with the given bind address.

Examples: - ":7232" will accept all connections on port 7232 - "127.0.0.1:7232" will only accept local connections on port 7232