client

Documentation

Index

• func IsErrVersionMismatch(e error) bool
• type Client
  • func New(socketPath string, api spi.InterfaceSpec) (Client, error)
• type InfoClient
  • func NewPluginInfoClient(socketPath string) *InfoClient
  • func (i *InfoClient) GetFunctions() (map[string][]template.Function, error)
  • func (i *InfoClient) GetInfo() (plugin.Info, error)

Functions

func IsErrVersionMismatch

func IsErrVersionMismatch(e error) bool

IsErrVersionMismatch return true if the error is from mismatched api versions.

Types

type Client

type Client interface {

	// Call invokes an RPC method with an argument and a pointer to a result that will hold the return value.
	Call(method string, arg interface{}, result interface{}) error
}

Client allows execution of RPCs.

func New

func New(socketPath string, api spi.InterfaceSpec) (Client, error)

New creates a new Client that communicates with a unix socket and validates the remote API.

type InfoClient

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

InfoClient is the client for retrieving plugin info

func NewPluginInfoClient

func NewPluginInfoClient(socketPath string) *InfoClient

NewPluginInfoClient returns a plugin informer that can give metadata about a plugin

func (*InfoClient) GetFunctions

func (i *InfoClient) GetFunctions() (map[string][]template.Function, error)

GetFunctions returns metadata about the plugin's template functions, if the plugin supports templating.

func (*InfoClient) GetInfo

func (i *InfoClient) GetInfo() (plugin.Info, error)

GetInfo implements the Info interface and returns the metadata about the plugin