command

type Handler ¶

type Handler func(ctx *types.PluginContext, body []byte) ([]byte, error)

Handler is a function that processes a command called from the frontend. It is expected to return the response body as a byte slice.

type Manager ¶

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

Manager manages the lifecycle of the terminal sessions.

func NewManager(
	log hclog.Logger,
	sp settings.Provider,
	handlers map[string]Handler,
) *Manager

func (m *Manager) Call(
	ctx *types.PluginContext,
	target string,
	payload []byte,
) ([]byte, error)

type Plugin ¶

type Plugin struct {
	plugin.Plugin
	Impl Provider
}

func (p *Plugin) GRPCClient(
	_ context.Context,
	_ *plugin.GRPCBroker,
	c *grpc.ClientConn,
) (interface{}, error)

func (p *Plugin) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error

type PluginClient ¶

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

func (p *PluginClient) Call(
	ctx *types.PluginContext,
	path string,
	body []byte,
) ([]byte, error)

type PluginOpts ¶

type PluginOpts struct {
	Handlers map[string]Handler `json:"handlers"`
}

PluginOpts contains the options for the command plugin.

type PluginServer ¶

type PluginServer struct {
	Impl Provider
	// contains filtered or unexported fields
}

func (s *PluginServer) Call(
	ctx context.Context,
	req *proto.CallCommandRequest,
) (*proto.CallCommandResponse, error)

type Provider ¶

type Provider interface {
	ProviderImpl
}

Provider is the interface satisfied by the plugin server and client to provide the general functionality.

type ProviderImpl ¶

type ProviderImpl interface {
	Call(ctx *types.PluginContext, target string, payload []byte) ([]byte, error)
}