Documentation
¶
Index ¶
- type InitialCapabilityRegistrationDoneFunc
- type PluginHostRoot
- func (r *PluginHostRoot) AccessAssetsFS(ctx context.Context, req *sdk_plugin_host.AccessAssetsFSRequest) (*sdk_plugin_host.AccessAssetsFSResponse, error)
- func (r *PluginHostRoot) AccessDesktopTray(ctx context.Context, req *sdk_plugin_host.AccessDesktopTrayRequest) (*sdk_plugin_host.AccessDesktopTrayResponse, error)
- func (r *PluginHostRoot) AccessDistFS(ctx context.Context, req *sdk_plugin_host.AccessDistFSRequest) (*sdk_plugin_host.AccessDistFSResponse, error)
- func (r *PluginHostRoot) AccessStateAtom(ctx context.Context, req *sdk_plugin_host.AccessStateAtomRequest) (*sdk_plugin_host.AccessStateAtomResponse, error)
- func (r *PluginHostRoot) AccessVolume(ctx context.Context, req *sdk_plugin_host.AccessVolumeRequest) (*sdk_plugin_host.AccessVolumeResponse, error)
- func (r *PluginHostRoot) CompleteInitialCapabilityRegistration(context.Context, *sdk_plugin_host.CompleteInitialCapabilityRegistrationRequest) (*sdk_plugin_host.CompleteInitialCapabilityRegistrationResponse, error)
- func (r *PluginHostRoot) GetMux() srpc.Invoker
- func (r *PluginHostRoot) GetPluginInfo(ctx context.Context, req *sdk_plugin_host.GetPluginInfoRequest) (*sdk_plugin_host.GetPluginInfoResponse, error)
- func (r *PluginHostRoot) Release()
- func (r *PluginHostRoot) WatchForgeWorker(_ *sdk_plugin_host.WatchForgeWorkerRequest, ...) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type InitialCapabilityRegistrationDoneFunc ¶ added in v0.56.1
type InitialCapabilityRegistrationDoneFunc func(complete bool)
InitialCapabilityRegistrationDoneFunc reports whether the plugin completed its initial capability-registration pass before its instance ended.
type PluginHostRoot ¶
type PluginHostRoot struct {
// contains filtered or unexported fields
}
PluginHostRoot is the root resource a plugin reaches through its host. It implements PluginHostResourceService: filesystem access, the host volume proxy, state atoms, the desktop tray, plugin info, and the initial capability-registration signal.
func NewPluginHostRoot ¶
func NewPluginHostRoot( b bus.Bus, pluginID, entrypoint string, distFS, assetsFS *unixfs.FSHandle, proxyHostVol *volume_rpc_server.ProxyVolume, hostRoot *plugin_host_root.Root, stateAtomObjectStoreID, stateAtomVolumeID string, registrationDone InitialCapabilityRegistrationDoneFunc, ) *PluginHostRoot
NewPluginHostRoot constructs a new PluginHostRoot.
func (*PluginHostRoot) AccessAssetsFS ¶
func (r *PluginHostRoot) AccessAssetsFS( ctx context.Context, req *sdk_plugin_host.AccessAssetsFSRequest, ) (*sdk_plugin_host.AccessAssetsFSResponse, error)
AccessAssetsFS returns a resource ID for the plugin's assets filesystem.
func (*PluginHostRoot) AccessDesktopTray ¶ added in v0.51.2
func (r *PluginHostRoot) AccessDesktopTray( ctx context.Context, req *sdk_plugin_host.AccessDesktopTrayRequest, ) (*sdk_plugin_host.AccessDesktopTrayResponse, error)
AccessDesktopTray returns a resource ID for the process-lifetime desktop tray.
func (*PluginHostRoot) AccessDistFS ¶
func (r *PluginHostRoot) AccessDistFS( ctx context.Context, req *sdk_plugin_host.AccessDistFSRequest, ) (*sdk_plugin_host.AccessDistFSResponse, error)
AccessDistFS returns a resource ID for the plugin's dist filesystem.
func (*PluginHostRoot) AccessStateAtom ¶
func (r *PluginHostRoot) AccessStateAtom( ctx context.Context, req *sdk_plugin_host.AccessStateAtomRequest, ) (*sdk_plugin_host.AccessStateAtomResponse, error)
AccessStateAtom returns a resource ID for a state atom store.
func (*PluginHostRoot) AccessVolume ¶
func (r *PluginHostRoot) AccessVolume( ctx context.Context, req *sdk_plugin_host.AccessVolumeRequest, ) (*sdk_plugin_host.AccessVolumeResponse, error)
AccessVolume returns a resource ID for the plugin's host volume.
func (*PluginHostRoot) CompleteInitialCapabilityRegistration ¶ added in v0.56.1
func (r *PluginHostRoot) CompleteInitialCapabilityRegistration( context.Context, *sdk_plugin_host.CompleteInitialCapabilityRegistrationRequest, ) (*sdk_plugin_host.CompleteInitialCapabilityRegistrationResponse, error)
CompleteInitialCapabilityRegistration marks the plugin's initial capability registration pass complete.
func (*PluginHostRoot) GetMux ¶
func (r *PluginHostRoot) GetMux() srpc.Invoker
GetMux returns the RPC mux for the root resource.
func (*PluginHostRoot) GetPluginInfo ¶
func (r *PluginHostRoot) GetPluginInfo( ctx context.Context, req *sdk_plugin_host.GetPluginInfoRequest, ) (*sdk_plugin_host.GetPluginInfoResponse, error)
GetPluginInfo returns information about the running plugin.
func (*PluginHostRoot) Release ¶
func (r *PluginHostRoot) Release()
Release releases all resources held by the root.
func (*PluginHostRoot) WatchForgeWorker ¶
func (r *PluginHostRoot) WatchForgeWorker( _ *sdk_plugin_host.WatchForgeWorkerRequest, stream sdk_plugin_host.SRPCPluginHostResourceService_WatchForgeWorkerStream, ) error
WatchForgeWorker forwards the current Forge Worker declaration and every subsequent revision.
Source Files