puzzledb

Documentation

Index

• Constants
• Variables
• type Config
  • func NewConfig() (Config, error)
  • func NewConfigWithPath(path string) (Config, error)
  • func NewConfigWithString(config string) (Config, error)
• type Server
  • func NewServer() *Server
  • func NewServerWithConfig(config Config) *Server
  • func (server *Server) LoadPlugins() error
  • func (server *Server) Restart() error
  • func (server *Server) SetConfig(config Config)
  • func (server *Server) Start() error
  • func (server *Server) Stop() error
• type ServerConfig
  • func NewServerConfigWith(config Config) *ServerConfig
  • func (conf *ServerConfig) Port(name string) (int, error)
  • func (conf *ServerConfig) String() string

Constants

const (
	// ProductName is the product name.
	ProductName = "puzzledb"
)

const (
	Version = "v0.8.0"
)

Variables

var ErrNotFound = errors.New("not found")

Types

type Config

type Config interface {
	// Get returns a value for the specified name.
	Get(name ...string) (any, error)
	// GetString returns a string value for the specified name.
	GetString(name ...string) (string, error)
	// GetInt returns an integer value for the specified name.
	GetInt(name ...string) (int, error)
	// String returns a string representation of the configuration.
	String() string
}

Config represents a configuration interface.

func NewConfig

func NewConfig() (Config, error)

NewConfig returns a new configuration.

func NewConfigWithPath

func NewConfigWithPath(path string) (Config, error)

NewConfigWithPath returns a new configuration with the specified path.

func NewConfigWithString

func NewConfigWithString(config string) (Config, error)

NewConfigWithString returns a new configuration with the specified string.

type Server

type Server struct {
	*ServerConfig
	*plugins.Manager
}

Server represents a server instance.

func NewServer

func NewServer() *Server

NewServer returns a new server instance.

func NewServerWithConfig

func NewServerWithConfig(config Config) *Server

NewServerWithConfig returns a new server instance with the specified configuration.

func (*Server) LoadPlugins

func (server *Server) LoadPlugins() error

func (*Server) Restart

func (server *Server) Restart() error

Restart restarts the server.

func (*Server) SetConfig

func (server *Server) SetConfig(config Config)

SetConfig sets the server configuration.

func (*Server) Start

func (server *Server) Start() error

Start starts the server.

func (*Server) Stop

func (server *Server) Stop() error

Stop stops the server.

type ServerConfig

type ServerConfig struct {
	Config
}

func NewServerConfigWith

func NewServerConfigWith(config Config) *ServerConfig

func (*ServerConfig) Port

func (conf *ServerConfig) Port(name string) (int, error)

Port returns a port number for the specified name.

func (*ServerConfig) String

func (conf *ServerConfig) String() string