plugin

type Endpoint struct {

	// Name is the key used to refer to this plugin in all JSON configs
	Name string

	// Protocol is the transport protocol -- unix, tcp, etc.
	Protocol string

	// Address is the how to connect - socket file, host:port, etc.
	Address string
}

type Info struct {

	// Vendor captures vendor-specific information about this plugin
	Vendor *spi.VendorInfo

	// Implements is a list of plugin interface and versions this plugin supports
	Implements []spi.InterfaceSpec

	// Interfaces (optional) is a slice of interface descriptions by the type and version
	Interfaces []InterfaceDescription `json:",omitempty"`
}

type Informer interface {

	// GetInfo returns metadata about the plugin
	GetInfo() (Info, error)

	// GetFunctions returns metadata about the plugin's template functions, if the plugin supports templating.
	GetFunctions() (map[string][]template.Function, error)
}

type InterfaceDescription struct {
	spi.InterfaceSpec
	Methods []MethodDescription
}

type Metadata struct {
	// Kind is the kind of the plugin (e.g. group, ingress, aws)
	Kind string
	// Name is the endpoint of the object
	Name Name
	// Instance is optionally a key for an object indexable within the remote plugin
	Instance string
	// InterfaceSpec is the interface definition of the remote object
	InterfaceSpec spi.InterfaceSpec
}

type MethodDescription struct {
	// Request is the RPC request example
	Request Request

	// Response is the RPC response example
	Response Response
}

type Name string

type Request struct {

	// Version is the version of the JSON RPC protocol
	Version string `json:"jsonrpc"`

	// Method is the rpc method to use in the payload field 'method'
	Method string `json:"method"`

	// Params contains example inputs.  This can be a zero value struct or one with defaults
	Params interface{} `json:"params"`

	// ID is the request is
	ID string `json:"id"`
}

type Response struct {

	// Result is the result of the call
	Result interface{} `json:"result"`

	// ID is id matching the request ID
	ID string `json:"id"`
}

type Spec struct {

	// Plugin is the name of the plugin
	Plugin Name

	// Properties is the configuration of the plugin
	Properties *types.Any
}

type Transport struct {
	// Name is the name of the plugin
	Name Name

	// Listen host:port. If not specified, the default behavior is to use unix socket locally
	Listen string

	// Advertise is the host:port used for others to discover this endpoint
	Advertise string

	// Dir is the directory for discovery (ie location of the socket files, etc.)
	// If not specified, it will default to system settings (via environment variable -- see pkg/discovery/local
	Dir string
}