server

Documentation

Index

• type Config
• type Server
  • func New(conf *Config) (Server, error)

Types

type Config

type Config struct {
	HTTPAddressSpec string
	CatalogMap      store.CatalogMap
	Authenticator   auth.Authenticator
	Middlewares     []rest.Middleware
	RequireHTTPS    bool
}

Config encapsulates REST server configuration parameters

type Server

type Server interface {
	Start() error
	Stop()
}

Server defines an interface for controlling server lifecycle

func New

func New(conf *Config) (Server, error)

New creates a new server based on the provided configuration options. Returns a valid Server interface on success or an error on failure