service

type Config struct {
	// Name should hold the name of the instance and is used
	// for metrics and logging
	Name string

	// InputLoader is the configuration loader that should be used
	// by the service instance. To try multiple loaders see
	// config.ChainLoader(...)
	InputLoader config.Loader

	// DisableEnvSubstition can be set to disable the replacement
	// of environment variables used in the configuration content
	// returned by InputLoader. When environment variable substition
	// is enabled a service will use github.com/a8m/envsubst.String
	// during LoadConfig. If a custom substitution function is required
	// see ConfigTokenSubstutionFunc below
	DisableEnvSubstition bool

	// ConfigTokenSubstutionFunc can be used to specify an alternative
	// configuration token substition function. If unset, a service
	// may use - see DisableEnvSubstition above - github.com/a8m/envsubst.String
	// to substitute environment variables found in the configuration
	// data returned by InputLoader. Setting this field will overwrite the
	// DisableEnvSubstition settings and the user is responsible to taking
	// care of environment variable substition them self
	ConfigTokenSubstutionFunc config.TokenSubstitutionFunc

	// Directives holds a list of configuration directives that are supported
	// by the service instance. Note that directive setup functions will be called
	// in the order the are listed below and *not* in the order they are defined
	// in the configuration file.
	Directives []Directive

	// Modules holds a list of API modules that should be mounted
	// on the service router
	Modules []api.Module
	// contains filtered or unexported fields
}

type Directive struct {
	// Name is the name of the directive as it will appear
	// in the configuration file
	Name string

	// Setup is called when the directive is used inside the configuratio
	// file. It receives the service instance as well as a token dispenser
	// for all occurences of the directive. For more information checkout
	// config.Parse.ForEachInOrder
	Init func(*Instance, config.Dispenser) error
}

type Instance struct {
	// Router holds the root api.Router that is used by the instance
	Router api.Router

	// Logger is the default logger used by the service instance
	// If not configured it will default to log.Log
	Logger log.Interface
	// contains filtered or unexported fields
}