rpc

Documentation

Overview

Package rpc defines "RPC" flavor, which combines all plugins that provide RPC-like access.

Index

• func NewAgent(opts ...core.Option) *core.Agent
• func WithPlugins(listPlugins func(local *FlavorRPC) []*core.NamedPlugin) core.WithPluginsOpt
• type FlavorRPC
  • func (f *FlavorRPC) Inject() bool
  • func (f *FlavorRPC) Plugins() []*core.NamedPlugin

Functions

func NewAgent

func NewAgent(opts ...core.Option) *core.Agent

NewAgent returns a new instance of the Agent with plugins. It is an alias for core.NewAgent() to implicit use of the FlavorRPC

func WithPlugins

func WithPlugins(listPlugins func(local *FlavorRPC) []*core.NamedPlugin) core.WithPluginsOpt

WithPlugins for adding custom plugins to SFC Controller <listPlugins> is a callback that uses flavor input to inject dependencies for custom plugins that are in output

Example:

   NewAgent(rpc.WithPlugins(func(flavor) {
	       return []*core.NamedPlugin{{"my-plugin", &MyPlugin{DependencyXY: &flavor.GRPC}}}
   }))

Types

type FlavorRPC

type FlavorRPC struct {
	*local.FlavorLocal

	HTTP       rest.Plugin
	HTTPProbe  rest.ForkPlugin
	Prometheus prometheus.Plugin

	HealthRPC     probe.Plugin
	PrometheusRPC probe.PrometheusPlugin

	GRPC grpc.Plugin
	// contains filtered or unexported fields
}

FlavorRPC glues together multiple plugins that provide RPC-like access. They are typically used to enable remote management for other plugins.

func (*FlavorRPC) Inject

func (f *FlavorRPC) Inject() bool

Inject initializes flavor references/dependencies.

func (*FlavorRPC) Plugins

func (f *FlavorRPC) Plugins() []*core.NamedPlugin

Plugins combines all Plugins in flavor to the list.