shared

Documentation

Index

• Variables
• type GRPCClient
  • func (c *GRPCClient) Apply(req *proto.ApplyRequest) (*proto.ApplyResponse, error)
  • func (c *GRPCClient) ListRules(req *proto.ListRulesRequest) (*proto.ListRulesResponse, error)
• type GRPCServer
  • func (s *GRPCServer) Apply(_ context.Context, req *proto.ApplyRequest) (*proto.ApplyResponse, error)
  • func (s *GRPCServer) ListRules(_ context.Context, req *proto.ListRulesRequest) (*proto.ListRulesResponse, error)
• type RuleSet
• type RuleSetGRPCPlugin
  • func (p *RuleSetGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (p *RuleSetGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

Variables

var Handshake = plugin.HandshakeConfig{
	ProtocolVersion:  1,
	MagicCookieKey:   "BASIC_PLUGIN",
	MagicCookieValue: "hello",
}

Handshake is a common handshake that is shared by plugin and host.

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

PluginMap is the map of plugins we can dispense.

Types

type GRPCClient

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

GRPCClient is the implementation of RuleSet.

func (*GRPCClient) Apply

func (c *GRPCClient) Apply(req *proto.ApplyRequest) (*proto.ApplyResponse, error)

Apply applies the rule to the proto.

func (*GRPCClient) ListRules

func (c *GRPCClient) ListRules(req *proto.ListRulesRequest) (*proto.ListRulesResponse, error)

ListRules returns all supported rules metadata.

type GRPCServer

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

GRPCServer is the implementation of RuleSet.

func (*GRPCServer) Apply

func (s *GRPCServer) Apply(_ context.Context, req *proto.ApplyRequest) (*proto.ApplyResponse, error)

Apply applies the rule to the proto.

func (*GRPCServer) ListRules

func (s *GRPCServer) ListRules(_ context.Context, req *proto.ListRulesRequest) (*proto.ListRulesResponse, error)

ListRules returns all supported rules metadata.

type RuleSet

type RuleSet interface {
	ListRules(*proto.ListRulesRequest) (*proto.ListRulesResponse, error)
	Apply(*proto.ApplyRequest) (*proto.ApplyResponse, error)
}

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

type RuleSetGRPCPlugin

type RuleSetGRPCPlugin struct {
	plugin.Plugin
	Impl RuleSet
}

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

func (*RuleSetGRPCPlugin) GRPCClient

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

GRPCClient returns the interface implementation for the plugin.

func (*RuleSetGRPCPlugin) GRPCServer

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

GRPCServer registers this plugin.