Documentation
¶
Index ¶
- Variables
- func AfterUpdateApply(context Context, willRestart bool, force bool, log Log) error
- func AutoInstall(context Context, _ string, _ bool, log Log) (bool, error)
- func BinPath() (string, error)
- func CheckIfValidLocation() error
- func IsInUse(mountDir string, log Log) bool
- func KBFSBinPath(runMode libkb.RunMode, binPath string) (string, error)
- func KBFSBundleVersion(context Context, binPath string) (string, error)
- func ResolveInstallStatus(version string, bundleVersion string, lastExitStatus string, log Log) (installStatus keybase1.InstallStatus, installAction keybase1.InstallAction, ...)
- func RunAfterStartup(context Context, isService bool, log Log) error
- func RunApp(context Context, log Log) error
- func TerminateApp(context Context, log Log) error
- func UpdaterBinPath() (string, error)
- type ComponentName
- type Context
- type Log
Constants ¶
This section is empty.
Variables ¶
var ComponentNames = []ComponentName{ComponentNameCLI, ComponentNameService, ComponentNameKBFS, ComponentNameUpdater}
ComponentNames are all the valid component names
Functions ¶
func AfterUpdateApply ¶ added in v1.0.17
func AutoInstall ¶
AutoInstall installs auto start on unix
func CheckIfValidLocation ¶
func CheckIfValidLocation() error
CheckIfValidLocation is not used on unix
func IsInUse ¶ added in v1.0.16
IsInUse returns true if the mount is in use. This may be used by the updater to determine if it's safe to apply an update and restart.
func KBFSBinPath ¶ added in v1.0.17
KBFSBinPath returns the path to the KBFS executable
func KBFSBundleVersion ¶
KBFSBundleVersion returns the bundle (not installed) version for KBFS
func ResolveInstallStatus ¶
func ResolveInstallStatus(version string, bundleVersion string, lastExitStatus string, log Log) (installStatus keybase1.InstallStatus, installAction keybase1.InstallAction, status keybase1.Status)
ResolveInstallStatus will determine necessary install actions for the current environment
func RunAfterStartup ¶
RunAfterStartup is not used on unix
func TerminateApp ¶ added in v1.0.17
TerminateApp will stop the Keybase (UI) app
func UpdaterBinPath ¶ added in v1.0.17
UpdaterBinPath returns the path to the updater executable, by default is in the same directory as the keybase executable.
Types ¶
type ComponentName ¶
type ComponentName string
ComponentName defines a component name
const ( // ComponentNameCLI is the command line component ComponentNameCLI ComponentName = "cli" // ComponentNameService is the service component ComponentNameService ComponentName = "service" // ComponentNameKBFS is the KBFS component ComponentNameKBFS ComponentName = "kbfs" // ComponentNameUpdater is the updater component ComponentNameUpdater ComponentName = "updater" // ComponentNameApp is the UI app ComponentNameApp ComponentName = "app" // ComponentNameUnknown is placeholder for unknown components ComponentNameUnknown ComponentName = "unknown" )
func ComponentNameFromString ¶
func ComponentNameFromString(s string) ComponentName
ComponentNameFromString returns ComponentName from a string
func (ComponentName) Description ¶ added in v1.0.17
func (c ComponentName) Description() string
Description returns description for component name
func (ComponentName) String ¶
func (c ComponentName) String() string
String returns string for ComponentName
type Context ¶
type Context interface {
GetConfigDir() string
GetCacheDir() string
GetRuntimeDir() string
GetMountDir() (string, error)
GetLogDir() string
GetRunMode() libkb.RunMode
GetServiceInfoPath() string
GetKBFSInfoPath() string
GetAppStartMode() (libkb.AppStartMode, error)
}
Context is the enviroment for this package
Source Files