pluginInternal

Documentation

Index

• Constants
• Variables
• func IsRPCPluginType() bool
• type FuncCaller
• type GRPCPlugin
  • func (p *GRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (p *GRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
• type GoPlugin
  • func (p *GoPlugin) Call(funcName string, args ...interface{}) (interface{}, error)
  • func (p *GoPlugin) Has(funcName string) bool
  • func (p *GoPlugin) Init(path string) error
  • func (p *GoPlugin) Quit() error
• type HashicorpPlugin
  • func (p *HashicorpPlugin) Call(funcName string, args ...interface{}) (interface{}, error)
  • func (p *HashicorpPlugin) Has(funcName string) bool
  • func (p *HashicorpPlugin) Init(path string) error
  • func (p *HashicorpPlugin) Quit() error
• type IPlugin
  • func Init(path string, logOn bool) (IPlugin, error)
• type RPCPlugin
  • func (RPCPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)
  • func (p *RPCPlugin) Server(*plugin.MuxBroker) (interface{}, error)

Constants

const GRPCPluginName = PluginName + "_grpc"

const PluginName = "debugtalk"

const RPCPluginName = PluginName + "_rpc"

Variables

var HandshakeConfig = plugin.HandshakeConfig{
	ProtocolVersion:  1,
	MagicCookieKey:   "HttpRunnerPlus",
	MagicCookieValue: PluginName,
}

handshakeConfigs are used to just do a basic handshake between a plugin and host. If the handshake fails, a user friendly error is shown. This prevents users from executing bad plugins or executing a plugin directory. It is a UX feature, not a security feature.

Functions

func IsRPCPluginType

func IsRPCPluginType() bool

Types

type FuncCaller

type FuncCaller interface {
	GetNames() ([]string, error)                                    // get all plugin function names list
	Call(funcName string, args ...interface{}) (interface{}, error) // call plugin function
}

FuncCaller is the interface that we're exposing as a plugin.

type GRPCPlugin

type GRPCPlugin struct {
	plugin.Plugin
	Impl FuncCaller
}

HRPPlugin implements hashicorp's plugin.GRPCPlugin.

func (*GRPCPlugin) GRPCClient

func (p *GRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (*GRPCPlugin) GRPCServer

func (p *GRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

type GoPlugin

type GoPlugin struct {
	*plugin.Plugin
	// contains filtered or unexported fields
}

GoPlugin implements golang official plugin

func (*GoPlugin) Call

func (p *GoPlugin) Call(funcName string, args ...interface{}) (interface{}, error)

func (*GoPlugin) Has

func (p *GoPlugin) Has(funcName string) bool

func (*GoPlugin) Init

func (p *GoPlugin) Init(path string) error

func (*GoPlugin) Quit

func (p *GoPlugin) Quit() error

type HashicorpPlugin

type HashicorpPlugin struct {
	FuncCaller
	// contains filtered or unexported fields
}

HashicorpPlugin implements hashicorp/go-plugin

func (*HashicorpPlugin) Call

func (p *HashicorpPlugin) Call(funcName string, args ...interface{}) (interface{}, error)

func (*HashicorpPlugin) Has

func (p *HashicorpPlugin) Has(funcName string) bool

func (*HashicorpPlugin) Init

func (p *HashicorpPlugin) Init(path string) error

func (*HashicorpPlugin) Quit

func (p *HashicorpPlugin) Quit() error

type IPlugin

type IPlugin interface {
	Init(path string) error                                         // init plugin
	Has(funcName string) bool                                       // check if plugin has function
	Call(funcName string, args ...interface{}) (interface{}, error) // call function
	Quit() error                                                    // quit plugin
}

func Init

func Init(path string, logOn bool) (IPlugin, error)

type RPCPlugin

type RPCPlugin struct {
	Impl FuncCaller
}

RPCPlugin implements hashicorp's plugin.Plugin.

func (RPCPlugin) Client

func (RPCPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)

func (*RPCPlugin) Server

func (p *RPCPlugin) Server(*plugin.MuxBroker) (interface{}, error)