apiserver

package

v0.1.26 Latest Latest Go to latest Published: Jan 7, 2026 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/minuk-dev/opampcommander

Links

Open Source Insights

Documentation ¶

Overview ¶

Package apiserver provides app logic for the opampcommander apiserver.

Index ¶

Constants
func NewConfigModule(settings *config.ServerSettings) fx.Option
type Server
- func New(settings config.ServerSettings) *Server
- func (s *Server) Run(ctx context.Context) error

Constants ¶

View Source

const (
	// DefaultServerStartTimeout = 30 * time.Second.
	DefaultServerStartTimeout = 30 * time.Second

	// DefaultServerStopTimeout is the default timeout for stopping the server.
	DefaultServerStopTimeout = 30 * time.Second
)

Variables ¶

This section is empty.

Functions ¶

func NewConfigModule ¶

func NewConfigModule(settings *config.ServerSettings) fx.Option

NewConfigModule creates a new module for configuration.

Types ¶

type Server ¶

type Server struct {
	*fx.App
	// contains filtered or unexported fields
}

Server is a struct that represents the server application. It embeds the fx.App struct from the Uber Fx framework.

func New ¶

func New(settings config.ServerSettings) *Server

New creates a new instance of the Server struct.

func (*Server) Run ¶

func (s *Server) Run(ctx context.Context) error

Run starts the server and blocks until the context is done.

Source Files ¶

View all Source files

apiserver.go

Directories ¶

Path	Synopsis
config Package config provides the configuration for the opampcommander application.	Package config provides the configuration for the opampcommander application.
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
module
application Package application provides the application services module for the API server.	Package application provides the application services module for the API server.
domain Package domain provides the domain services module for the API server.	Package domain provides the domain services module for the API server.
helper Package helper provides utility functions and types to assist in building the application.	Package helper provides utility functions and types to assist in building the application.
helper/lifecycle Package lifecycle provides application lifecycle management.	Package lifecycle provides application lifecycle management.
helper/management Package management provides management HTTP server functionality.	Package management provides management HTTP server functionality.
infrastructure Package infrastructure provides infrastructure components module for the API server.	Package infrastructure provides infrastructure components module for the API server.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL