Documentation
¶
Index ¶
- func DefaultConfig(path string, myID protocol.DeviceID, evLogger events.Logger, ...) (config.Wrapper, error)
- func LoadConfigAtStartup(path string, cert tls.Certificate, evLogger events.Logger, ...) (config.Wrapper, error)
- func LoadOrGenerateCertificate(certFile, keyFile string) (tls.Certificate, error)
- func OpenGoleveldb(path string, tuning config.Tuning) (*db.Lowlevel, error)
- type App
- type ExitStatus
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultConfig ¶ added in v1.2.2
func LoadConfigAtStartup ¶ added in v1.2.2
func LoadConfigAtStartup(path string, cert tls.Certificate, evLogger events.Logger, allowNewerConfig, noDefaultFolder bool) (config.Wrapper, error)
LoadConfigAtStartup loads an existing config. If it doesn't yet exist, it creates a default one, without the default folder if noDefaultFolder is ture. Otherwise it checks the version, and archives and upgrades the config if necessary or returns an error, if the version isn't compatible.
func LoadOrGenerateCertificate ¶ added in v1.2.2
func LoadOrGenerateCertificate(certFile, keyFile string) (tls.Certificate, error)
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
func (*App) Error ¶
Error returns an error if one occurred while running the app. It does not wait for the app to stop before returning.
func (*App) Run ¶
func (a *App) Run() ExitStatus
Run does the same as start, but then does not return until the app stops. It is equivalent to calling Start and then Wait.
func (*App) Start ¶
func (a *App) Start()
Start executes the app and returns once all the startup operations are done, e.g. the API is ready for use.
func (*App) Stop ¶
func (a *App) Stop(stopReason ExitStatus) ExitStatus
Stop stops the app and sets its exit status to given reason, unless the app was already stopped before. In any case it returns the effective exit status.
type ExitStatus ¶
type ExitStatus int
const ( ExitSuccess ExitStatus = 0 ExitError ExitStatus = 1 ExitRestart ExitStatus = 3 ExitUpgrade ExitStatus = 4 )
Source Files