syncthing

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 OpenDBBackend(path string, tuning config.Tuning) (backend.Backend, error)
• type App
  • func New(cfg config.Wrapper, dbBackend backend.Backend, evLogger events.Logger, ...) *App
  • func (a *App) Error() error
  • func (a *App) Start() error
  • func (a *App) Stop(stopReason ExitStatus) ExitStatus
  • func (a *App) Wait() ExitStatus
• type ExitStatus
  • func (s ExitStatus) AsInt() int
• type Options

Functions

func DefaultConfig

func DefaultConfig(path string, myID protocol.DeviceID, evLogger events.Logger, noDefaultFolder bool) (config.Wrapper, error)

func LoadConfigAtStartup

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

func LoadOrGenerateCertificate(certFile, keyFile string) (tls.Certificate, error)

func OpenDBBackend

func OpenDBBackend(path string, tuning config.Tuning) (backend.Backend, error)

Types

type App

type App struct {
	// contains filtered or unexported fields
}

func New

func New(cfg config.Wrapper, dbBackend backend.Backend, evLogger events.Logger, cert tls.Certificate, opts Options) *App

func (*App) Error

func (a *App) Error() 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) Start

func (a *App) Start() error

Start executes the app and returns once all the startup operations are done, e.g. the API is ready for use. Must be called once only.

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.

func (*App) Wait

func (a *App) Wait() ExitStatus

Wait blocks until the app stops running. Also returns if the app hasn't been started yet.

type ExitStatus

type ExitStatus int

const (
	ExitSuccess            ExitStatus = 0
	ExitError              ExitStatus = 1
	ExitNoUpgradeAvailable ExitStatus = 2
	ExitRestart            ExitStatus = 3
	ExitUpgrade            ExitStatus = 4
)

func (ExitStatus) AsInt

func (s ExitStatus) AsInt() int

type Options

type Options struct {
	AssetDir         string
	AuditWriter      io.Writer
	DeadlockTimeoutS int
	NoUpgrade        bool
	ProfilerURL      string
	ResetDeltaIdxs   bool
	Verbose          bool
	// null duration means use default value
	DBRecheckInterval    time.Duration
	DBIndirectGCInterval time.Duration
}