config

type CustomOption interface{}

type NirvanaCommand interface {
	// EnablePlugin enables plugins.
	EnablePlugin(plugins ...Plugin) NirvanaCommand
	// AddOption will fill up options from flags/ENV/config after executing.
	// A non-empty prefix is recommended. It's used to divide option namespaces.
	AddOption(prefix string, options ...CustomOption) NirvanaCommand
	// Add adds a field by key.
	// If you don't have any struct to describe an option, you can use the method to
	// add a single field into nirvana command.
	// `pointer` must be a pointer to golang basic data type (e.g. *int, *string).
	// `key` must a config key. It's like 'nirvana.ip' and 'myconfig.name.firstName'.
	// The key will be converted to flag and env (e.g. --nirvana-ip and NIRVANA_IP).
	// If you want a short flag for the field, you can only set a one-char string.
	// `desc` describes the field.
	Add(pointer interface{}, key string, shortFlag string, desc string) NirvanaCommand
	// Execute runs nirvana server.
	Execute(descriptors ...interface{}) error
	// ExecuteWithConfig runs nirvana server from a custom config.
	ExecuteWithConfig(cfg *nirvana.Config) error
	// Command returns a command for command.
	Command(cfg *nirvana.Config) *cobra.Command
	// SetHook sets nirvana command hook.
	SetHook(hook NirvanaCommandHook)
	// Hook returns nirvana command hook.
	Hook() NirvanaCommandHook
}

type NirvanaCommandHook interface {
	// PreConfigure runs before installing plugins.
	PreConfigure(config *nirvana.Config) error
	// PostConfigure runs after installing plugins and before creating nirvana server.
	PostConfigure(config *nirvana.Config) error
	// PreServe runs before nirvana server serving.
	PreServe(config *nirvana.Config, server nirvana.Server) error
	// PostServe runs after nirvana server shutting down or any error occurring.
	PostServe(config *nirvana.Config, server nirvana.Server, err error) error
}

type NirvanaCommandHookFunc struct {
	PreConfigureFunc  func(config *nirvana.Config) error
	PostConfigureFunc func(config *nirvana.Config) error
	PreServeFunc      func(config *nirvana.Config, server nirvana.Server) error
	PostServeFunc     func(config *nirvana.Config, server nirvana.Server, err error) error
}

type Option struct {
	// IP is the IP to listen.
	IP string `desc:"Nirvana server listening IP"`
	// Port is the port to listen.
	Port uint16 `desc:"Nirvana server listening Port"`
	// Key is private key for HTTPS.
	Key string `desc:"TLS private key (PEM format) for HTTPS"`
	// Cert is certificate for HTTPS.
	Cert string `desc:"TLS certificate (PEM format) for HTTPS"`
}

type Plugin interface {
	// Name returns plugin name.
	Name() string
	// Configure configures nirvana config via current options.
	Configure(cfg *nirvana.Config) error
}