shared

Documentation

Overview

Package shared contains shared data between the host and plugins.

Index

• Constants
• Variables
• type GRPCClient
  • func (m *GRPCClient) Get(key string) ([]byte, error)
  • func (m *GRPCClient) Keys() ([]string, error)
  • func (m *GRPCClient) Put(key string, value []byte) error
• type GRPCServer
  • func (m *GRPCServer) Get(ctx context.Context, req *proto.GetRequest) (*proto.GetResponse, error)
  • func (m *GRPCServer) Keys(ctx context.Context, req *proto.Empty) (*proto.KeysResponse, error)
  • func (m *GRPCServer) Put(ctx context.Context, req *proto.PutRequest) (*proto.Empty, error)
• type KV
• type KVGRPCPlugin
  • func (p *KVGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (p *KVGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
• type KVPlugin
  • func (*KVPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)
  • func (p *KVPlugin) Server(*plugin.MuxBroker) (interface{}, error)
• type RPCClient
  • func (m *RPCClient) Get(key string) ([]byte, error)
  • func (m *RPCClient) Put(key string, value []byte) error
• type RPCServer
  • func (m *RPCServer) Get(key string, resp *[]byte) error
  • func (m *RPCServer) Put(args map[string]interface{}, resp *interface{}) error

Constants

const PluginName = "kv"

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{
	"kv_grpc":  &KVGRPCPlugin{},
	PluginName: &KVPlugin{},
}

PluginMap is the map of plugins we can dispense.

Types

type GRPCClient

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

GRPCClient is an implementation of KV that talks over RPC.

func (*GRPCClient) Get

func (m *GRPCClient) Get(key string) ([]byte, error)

func (*GRPCClient) Keys

func (m *GRPCClient) Keys() ([]string, error)

func (*GRPCClient) Put

func (m *GRPCClient) Put(key string, value []byte) error

type GRPCServer

type GRPCServer struct {
	// This is the real implementation
	Impl KV
}

Here is the gRPC server that GRPCClient talks to.

func (*GRPCServer) Get

func (m *GRPCServer) Get(
	ctx context.Context,
	req *proto.GetRequest) (*proto.GetResponse, error)

func (*GRPCServer) Keys

func (m *GRPCServer) Keys(
	ctx context.Context,
	req *proto.Empty) (*proto.KeysResponse, error)

func (*GRPCServer) Put

func (m *GRPCServer) Put(
	ctx context.Context,
	req *proto.PutRequest) (*proto.Empty, error)

type KV

type KV interface {
	Put(key string, value []byte) error
	Get(key string) ([]byte, error)
	Keys() ([]string, error)
}

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

type KVGRPCPlugin

type KVGRPCPlugin 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 KV
}

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

func (*KVGRPCPlugin) GRPCClient

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

func (*KVGRPCPlugin) GRPCServer

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

type KVPlugin

type KVPlugin struct {
	// Concrete implementation, written in Go. This is only used for plugins
	// that are written in Go.
	Impl KV
}

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

func (*KVPlugin) Client

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

func (*KVPlugin) Server

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

type RPCClient

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

RPCClient is an implementation of KV that talks over RPC.

func (*RPCClient) Get

func (m *RPCClient) Get(key string) ([]byte, error)

func (*RPCClient) Put

func (m *RPCClient) Put(key string, value []byte) error

type RPCServer

type RPCServer struct {
	// This is the real implementation
	Impl KV
}

Here is the RPC server that RPCClient talks to, conforming to the requirements of net/rpc

func (*RPCServer) Get

func (m *RPCServer) Get(key string, resp *[]byte) error

func (*RPCServer) Put

func (m *RPCServer) Put(args map[string]interface{}, resp *interface{}) error