plugin

Documentation

Index

• Variables
• func GetProviderPath(name string, version string) (string, error)
• type CQPlugin
  • func (p *CQPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (p *CQPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
• type CQProvider
• type GRPCClient
  • func (m *GRPCClient) Fetch(data []byte) error
  • func (m *GRPCClient) GenConfig() (string, error)
  • func (m *GRPCClient) Init(driver string, dsn string, verbose bool) error
• type GRPCServer
  • func (m *GRPCServer) Fetch(ctx context.Context, req *proto.FetchRequest) (*proto.FetchResponse, error)
  • func (m *GRPCServer) GenConfig(ctx context.Context, req *proto.GenConfigRequest) (*proto.GenConfigResponse, error)
  • func (m *GRPCServer) Init(ctx context.Context, req *proto.InitRequest) (*proto.InitResponse, error)
• type Manager
  • func GetManager() *Manager
  • func (p *Manager) AddEmbeddedPlugin(providerName string, cqp CQProvider)
  • func (p *Manager) GetOrCreateProvider(providerName, version string) (CQProvider, error)
  • func (p *Manager) GetProvider(providerName, version string) (CQProvider, error)
  • func (p *Manager) KillProvider(providerName string) error
  • func (p *Manager) Shutdown()

Variables

var Handshake = plugin.HandshakeConfig{
	MagicCookieKey:   "CQ_PLUGIN_COOKIE",
	MagicCookieValue: "6753812e-79c2-4af5-ad01-e6083c374e1f",
}

var PluginMap = map[string]plugin.Plugin{
	"provider": &CQPlugin{},
}

PluginMap is the map of plugins we can dispense.

Functions

func GetProviderPath

func GetProviderPath(name string, version string) (string, error)

GetProviderPath returns expected path of provider on file system from name and version of plugin

Types

type CQPlugin

type CQPlugin struct {
	// GRPCPlugin must still implement the Plugin interface
	plugin.Plugin
	// Concrete implementation, written in Go. This is only used for plugins
	// that are written in Go.
	Impl CQProvider
}

This is the implementation of plugin.GRPCPlugin so we can serve/consume this.

func (*CQPlugin) GRPCClient

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

func (*CQPlugin) GRPCServer

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

type CQProvider

type CQProvider interface {
	Init(driver string, dsn string, verbose bool) error
	Fetch(data []byte) error
	GenConfig() (string, error)
}

type GRPCClient

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

func (*GRPCClient) Fetch

func (m *GRPCClient) Fetch(data []byte) error

func (*GRPCClient) GenConfig

func (m *GRPCClient) GenConfig() (string, error)

func (*GRPCClient) Init

func (m *GRPCClient) Init(driver string, dsn string, verbose bool) error

type GRPCServer

type GRPCServer struct {
	// This is the real implementation
	Impl CQProvider
	proto.UnimplementedProviderServer
}

Here is the gRPC server that GRPCClient talks to.

func (*GRPCServer) Fetch

func (m *GRPCServer) Fetch(ctx context.Context, req *proto.FetchRequest) (*proto.FetchResponse, error)

func (*GRPCServer) GenConfig

func (m *GRPCServer) GenConfig(ctx context.Context, req *proto.GenConfigRequest) (*proto.GenConfigResponse, error)

func (*GRPCServer) Init

func (m *GRPCServer) Init(ctx context.Context, req *proto.InitRequest) (*proto.InitResponse, error)

type Manager

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

Manager handles CQProviders that can be either embedded (self-run provider for example) or remote using go_plugin Important: manager is currently not thread safe

func GetManager

func GetManager() *Manager

func (*Manager) AddEmbeddedPlugin

func (p *Manager) AddEmbeddedPlugin(providerName string, cqp CQProvider)

func (*Manager) GetOrCreateProvider

func (p *Manager) GetOrCreateProvider(providerName, version string) (CQProvider, error)

func (*Manager) GetProvider

func (p *Manager) GetProvider(providerName, version string) (CQProvider, error)

func (*Manager) KillProvider

func (p *Manager) KillProvider(providerName string) error

func (*Manager) Shutdown

func (p *Manager) Shutdown()

Shutdown closes all clients and cleans the managed clients