service

Documentation

Index

• func ConfigureHandlers(r *mux.Router) error
• type BindAddress
• type Config
• type Environment
  • func NewEnvironment(env *Environment) (*Environment, error)
  • func (env *Environment) RunServers(await bool) func()
• type GlobalConfig
• type HTTPConfig
• type ServerConfig

Functions

func ConfigureHandlers

func ConfigureHandlers(r *mux.Router) error

configure handlers

Types

type BindAddress

type BindAddress struct {
	Address string
}

BindAddress specifies where the http server should bind to.

type Config

type Config struct {
	Servers ServerConfig
}

Config defines all the configuration for the app

type Environment

type Environment struct {
	Logger       log.Logger
	Config       *Config
	TimeService  *stime.TimeService
	PublicRouter *mux.Router
	Shutdown     func()
}

Environment - Contains everything thats been instantiated for this service.

func NewEnvironment

func NewEnvironment(env *Environment) (*Environment, error)

NewEnvironment - Generates a new default environment. Overrides can be specified via configs.

func (*Environment) RunServers

func (env *Environment) RunServers(await bool) func()

RunServers - Boots up all the servers and awaits till they are stopped.

type GlobalConfig

type GlobalConfig struct {
	Bai2 Config
}

type HTTPConfig

type HTTPConfig struct {
	Bind BindAddress
}

HTTPConfig configuration for running an http server

type ServerConfig

type ServerConfig struct {
	Public HTTPConfig
	Admin  HTTPConfig
}

ServerConfig - Groups all the http configs for the servers and ports that get opened.