app

Documentation

Index

• Constants
• type Application
  • func NewApp(acn connectivity.ACN, appDirectory string) Application
  • func NewAppClient(appDirectory string, bridge event.IPCBridge) Application
• type ApplicationService
  • func NewAppService(acn connectivity.ACN, appDirectory string, bridge event.IPCBridge) ApplicationService
• type LoadProfileFn

Constants

const (
	// DestApp should be used as a destination for IPC messages that are for the application itself an not a peer
	DestApp = "app"
)

Types

type Application

type Application interface {
	LoadProfiles(password string)
	CreatePeer(name string, password string)
	CreateTaggedPeer(name string, password string, tag string)
	DeletePeer(onion string, currentPassword string)
	AddPeerPlugin(onion string, pluginID plugins.PluginID)
	ChangePeerPassword(onion, oldpass, newpass string)
	LaunchPeers()

	GetPrimaryBus() event.Manager
	GetEventBus(onion string) event.Manager
	QueryACNStatus()
	QueryACNVersion()

	ShutdownPeer(string)
	Shutdown()

	GetPeer(onion string) peer.CwtchPeer
	ListProfiles() []string
}

Application is a full cwtch peer application. It allows management, usage and storage of multiple peers

func NewApp

func NewApp(acn connectivity.ACN, appDirectory string) Application

NewApp creates a new app with some environment awareness and initializes a Tor Manager

func NewAppClient

func NewAppClient(appDirectory string, bridge event.IPCBridge) Application

NewAppClient returns an Application that acts as a client to a AppService, connected by the IPCBridge supplied

type ApplicationService

type ApplicationService interface {
	Shutdown()
}

ApplicationService is the back end of an application that manages engines and writing storage and communicates to an ApplicationClient by an IPCBridge

func NewAppService

func NewAppService(acn connectivity.ACN, appDirectory string, bridge event.IPCBridge) ApplicationService

NewAppService returns an ApplicationService that runs the backend of an app and communicates with a client by the supplied IPCBridge

type LoadProfileFn

type LoadProfileFn func(profile *model.Profile, store storage.ProfileStore)

LoadProfileFn is the function signature for a function in an app that loads a profile