api

Documentation

Index

• type Server
  • func New(appConfig config.Config, logger *slog.Logger) *Server
  • func (s *Server) CreateHandlers(appFs afero.Fs, clientManager client.Manager) []func(e *echo.Echo)
  • func (s *Server) GetNetworkHandler(_ afero.Fs, clientManager client.Manager) []func(e *echo.Echo)
  • func (s *Server) GetSystemHandler() []func(e *echo.Echo)
  • func (s *Server) RegisterHandlers(handlers []func(e *echo.Echo))
  • func (s *Server) Start()
  • func (s *Server) Stop(ctx context.Context)
• type ServerManager

Types

type Server

type Server struct {
	Echo *echo.Echo
	// contains filtered or unexported fields
}

Server implementation of the Server's API operations.

func New

func New(
	appConfig config.Config,
	logger *slog.Logger,
) *Server

New initialize a new Server and configure an Echo server.

func (*Server) CreateHandlers

func (s *Server) CreateHandlers(
	appFs afero.Fs,
	clientManager client.Manager,
) []func(e *echo.Echo)

CreateHandlers initializes handlers and returns a slice of functions to register them.

func (*Server) GetNetworkHandler

func (s *Server) GetNetworkHandler(
	_ afero.Fs,
	clientManager client.Manager,
) []func(e *echo.Echo)

GetNetworkHandler returns network handler for registration.

func (*Server) GetSystemHandler

func (s *Server) GetSystemHandler() []func(e *echo.Echo)

GetSystemHandler returns system handler for registration.

func (*Server) RegisterHandlers

func (s *Server) RegisterHandlers(handlers []func(e *echo.Echo))

RegisterHandlers registers a list of handlers with the Echo instance.

func (*Server) Start

func (s *Server) Start()

Start starts the Echo server with the configured port.

func (*Server) Stop

func (s *Server) Stop(ctx context.Context)

Stop gracefully shuts down the Echo server.

type ServerManager

type ServerManager interface {
	// Start starts the Echo server with the configured port.
	Start()
	// Stop gracefully shuts down the Echo server.
	Stop(ctx context.Context)
	// CreateHandlers initializes handlers and returns a slice of functions to register them.
	CreateHandlers(
		appFs afero.Fs,
		clientManager client.Manager,
	) []func(e *echo.Echo)
	// RegisterHandlers registers a list of handlers with the Echo instance.
	RegisterHandlers(handlers []func(e *echo.Echo))
}

ServerManager responsible for Server operations.