phoenix

type Config interface {
	HasSection(section string) bool
	GetSections() []string
	GetOptions(section string) ([]string, error)
	HasOption(section, option string) bool
	GetBool(section, option string) (bool, error)
	GetBoolDefault(section, option string, dflt bool) bool
	GetInt(section, option string) (int, error)
	GetIntDefault(section, option string, dflt int) int
	GetFloat64(section, option string) (float64, error)
	GetFloat64Default(section, option string, dflt float64) float64
	GetString(section, option string) (string, error)
	GetStringDefault(section, option, dflt string) string
}

type ConfigUpdater interface {
	Config
	Update(map[string]map[string]string) error
}

type Container interface {
	ConfigUpdater
	Logger
	Metadata
}

type Logger interface {
	Print(...interface{})
	Printf(string, ...interface{})
}

type Metadata interface {
	// Name returns the the configured application name,
	// or "app" if none was set.
	Name() string

	// Version returns the configured version string,
	// or "unreleased" if no version string was provided.
	Version() string
}

type Reloadable interface {
	// Reload will be called when the server's configuration has been reloaded.
	//
	// If any reloadable service returns an error, the server will be stopped.
	Reload() error
}

type RunFunc func(Runtime) error

type Runtime interface {
	Container

	// Service specifies a Service to be managed by this runtime.
	Service(Service)

	// DefaultHTTPHandler specifies a handler which will be run
	// using the default HTTP server configuration.
	//
	// The results of calling this method after Start() has been
	// called are undefined.
	DefaultHTTPHandler(http.Handler)

	// DefaultHTTPSHandler specifies a handler which will be run
	// using the default HTTPS server configuration.
	//
	// The results of calling this method after Start() has been
	// called are undefined.
	DefaultHTTPSHandler(http.Handler)

	// TLSConfig returns the current tls.Config used with HTTPS servers
	// If no tls.Config is set, it is created using the options provided in
	// configuration. Modifications to the tls.Config the tls.Config are
	// propagated to existing HTTPS servers.
	//
	// Results of modifying the tls.Config after Start() has been called are
	// undefined.
	TLSConfig() (*tls.Config, error)

	// SetTLSConfig applies a given tls.Config to the runtime. It
	// will be used with all HTTPS servers created after SetTLSConfig
	// was called.
	SetTLSConfig(*tls.Config)

	// Start runs all registered servers and blocks until they terminate.
	Start() error
}

type Server interface {
	// DefaultOption sets the default value of the named option in the given
	// section.
	DefaultOption(section, option, value string) Server

	// OverrideOption forces the named option in the given section
	// to have the given value regardless of it's state in the
	// config file.
	OverrideOption(section, option, value string) Server

	// Config sets the path to the application's main config file.
	Config(path *string) Server

	// DefaultConfig sets the path to the application's default config file.
	DefaultConfig(path *string) Server

	// OverrideConfig sets the path to the application's override config file.
	OverrideConfig(path *string) Server

	// Log sets the path to the application's logfile. Defaults to stderr if unset.
	Log(path *string) Server

	// CpuProfile runs the application with CPU profiling enabled,
	// writing the results to path.
	CpuProfile(path *string) Server

	// MemProfile runs the application with memory profiling enabled,
	// writing the results to path.
	MemProfile(path *string) Server

	// Run initializes a Runtime instance and provides it to the runner callback,
	// returning any errors produced by the callback.
	//
	// Any errors resulting from loading the configuration or opening the log
	// will be returned without calling runner.
	Run(runner RunFunc) error

	// Stop forcibly halts the running instance.
	Stop() error
}

type Service interface {
	// Start runs the main loop of the Service. It is expected to block until
	// Stop is called or the execution of the service is complete.
	//
	// Undefined behavior will result if errors are returned during shutdown,
	// such errors shall be returned by Stop.
	Start() error

	// Stop shall terminate execution of Start and may return any errors
	// reported by cleanup of resources used by the Service.
	Stop() error
}

type StartHandler interface {
	// OnStart receives the current container, and may return an error to cancel
	// startup.
	OnStart(Container) error
}

type StopHandler interface {
	OnStop(Container)
}