README
¶
env
This package implements libkbfs.Context in terms of libkb.
Documentation
¶
Index ¶
- type AppStateUpdater
- type Context
- type EmptyAppStateUpdater
- type KBFSContext
- func (c *KBFSContext) BindToKBFSSocket() (net.Listener, error)
- func (c *KBFSContext) CheckService() error
- func (c *KBFSContext) ConfigureSocketInfo() error
- func (c *KBFSContext) GetDataDir() string
- func (c *KBFSContext) GetEnv() *libkb.Env
- func (c *KBFSContext) GetKBFSSocket(clearError bool) (net.Conn, rpc.Transporter, bool, error)
- func (c *KBFSContext) GetLogDir() string
- func (c *KBFSContext) GetMountDir() (string, error)
- func (c *KBFSContext) GetPerfLog() logger.Logger
- func (c *KBFSContext) GetRunMode() kbconst.RunMode
- func (c *KBFSContext) GetSocket(clearError bool) (net.Conn, rpc.Transporter, bool, error)
- func (c *KBFSContext) GetVDebugSetting() string
- func (c *KBFSContext) NewNetworkInstrumenter(src keybase1.NetworkSource) rpc.NetworkInstrumenterStorage
- func (c *KBFSContext) NewRPCLogFactory() rpc.LogFactory
- func (c *KBFSContext) NextAppStateUpdate(lastState *keybase1.MobileAppState) <-chan keybase1.MobileAppState
- func (c *KBFSContext) NextNetworkStateUpdate(lastState *keybase1.MobileNetworkState) <-chan keybase1.MobileNetworkState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppStateUpdater ¶
type AppStateUpdater interface {
// NextAppStateUpdate returns a channel that app state changes
// are sent to.
NextAppStateUpdate(lastState *keybase1.MobileAppState) <-chan keybase1.MobileAppState
// NextNetworkStateUpdate returns a channel that mobile network
// state changes are sent to.
NextNetworkStateUpdate(lastState *keybase1.MobileNetworkState) <-chan keybase1.MobileNetworkState
}
AppStateUpdater is an interface for things that need to listen to app state changes.
type Context ¶
type Context interface {
AppStateUpdater
GetRunMode() kbconst.RunMode
GetLogDir() string
GetDataDir() string
GetEnv() *libkb.Env
GetMountDir() (string, error)
ConfigureSocketInfo() (err error)
CheckService() error
GetSocket(clearError bool) (net.Conn, rpc.Transporter, bool, error)
NewRPCLogFactory() rpc.LogFactory
NewNetworkInstrumenter(keybase1.NetworkSource) rpc.NetworkInstrumenterStorage
GetKBFSSocket(clearError bool) (net.Conn, rpc.Transporter, bool, error)
BindToKBFSSocket() (net.Listener, error)
GetVDebugSetting() string
GetPerfLog() logger.Logger
}
Context defines the environment for this package
type EmptyAppStateUpdater ¶
type EmptyAppStateUpdater struct{}
EmptyAppStateUpdater is an implementation of AppStateUpdater that never returns an update, for testing.
func (EmptyAppStateUpdater) NextAppStateUpdate ¶
func (easu EmptyAppStateUpdater) NextAppStateUpdate(lastState *keybase1.MobileAppState) <-chan keybase1.MobileAppState
NextAppStateUpdate implements AppStateUpdater.
func (EmptyAppStateUpdater) NextNetworkStateUpdate ¶
func (easu EmptyAppStateUpdater) NextNetworkStateUpdate( lastState *keybase1.MobileNetworkState) <-chan keybase1.MobileNetworkState
NextNetworkStateUpdate implements AppStateUpdater.
type KBFSContext ¶
type KBFSContext struct {
// contains filtered or unexported fields
}
KBFSContext is an implementation for libkbfs.Context
func NewContext ¶
func NewContext() *KBFSContext
NewContext constructs a context. This should only be called once in main functions.
func NewContextFromGlobalContext ¶
func NewContextFromGlobalContext(g *libkb.GlobalContext) *KBFSContext
NewContextFromGlobalContext constructs a context
func NewContextWithPerfLog ¶
func NewContextWithPerfLog(logName string) *KBFSContext
NewContextWithPerfLog constructs a context with a specific perf log. This should only be called once in main functions.
func (*KBFSContext) BindToKBFSSocket ¶
func (c *KBFSContext) BindToKBFSSocket() (net.Listener, error)
BindToKBFSSocket binds to the socket configured in `c.kbfsSocket`.
func (*KBFSContext) CheckService ¶
func (c *KBFSContext) CheckService() error
CheckService checks if the service is running and returns nil if so, and an error otherwise.
func (*KBFSContext) ConfigureSocketInfo ¶
func (c *KBFSContext) ConfigureSocketInfo() error
ConfigureSocketInfo configures a socket
func (*KBFSContext) GetDataDir ¶
func (c *KBFSContext) GetDataDir() string
GetDataDir returns log dir
func (*KBFSContext) GetEnv ¶
func (c *KBFSContext) GetEnv() *libkb.Env
GetEnv returns the global Env
func (*KBFSContext) GetKBFSSocket ¶
func (c *KBFSContext) GetKBFSSocket(clearError bool) ( net.Conn, rpc.Transporter, bool, error)
GetKBFSSocket dials the socket configured in `c.kbfsSocket`. Adapted from github.com/keybase/client/go/libkb.GlobalContext.GetSocket.
func (*KBFSContext) GetMountDir ¶
func (c *KBFSContext) GetMountDir() (string, error)
GetMountDir returns mount dir
func (*KBFSContext) GetPerfLog ¶
func (c *KBFSContext) GetPerfLog() logger.Logger
GetPerfLog returns the perf log.
func (*KBFSContext) GetRunMode ¶
func (c *KBFSContext) GetRunMode() kbconst.RunMode
GetRunMode returns run mode
func (*KBFSContext) GetSocket ¶
func (c *KBFSContext) GetSocket(clearError bool) ( net.Conn, rpc.Transporter, bool, error)
GetSocket returns a socket
func (*KBFSContext) GetVDebugSetting ¶
func (c *KBFSContext) GetVDebugSetting() string
GetVDebugSetting returns the verbose debug logger.
func (*KBFSContext) NewNetworkInstrumenter ¶
func (c *KBFSContext) NewNetworkInstrumenter(src keybase1.NetworkSource) rpc.NetworkInstrumenterStorage
NewNetworkInstrumenter constructs an RPC NetworkInstrumenterStorage
func (*KBFSContext) NewRPCLogFactory ¶
func (c *KBFSContext) NewRPCLogFactory() rpc.LogFactory
NewRPCLogFactory constructs an RPC logger
func (*KBFSContext) NextAppStateUpdate ¶
func (c *KBFSContext) NextAppStateUpdate(lastState *keybase1.MobileAppState) <-chan keybase1.MobileAppState
NextAppStateUpdate implements AppStateUpdater.
func (*KBFSContext) NextNetworkStateUpdate ¶
func (c *KBFSContext) NextNetworkStateUpdate( lastState *keybase1.MobileNetworkState) <-chan keybase1.MobileNetworkState
NextNetworkStateUpdate implements AppStateUpdater.
Source Files