stnplugin

Documentation

Index

• Variables
• type Deps
• type Option
  • func UseDeps(f func(*Deps)) Option
• type STNPlugin
  • func NewPlugin(opts ...Option) *STNPlugin
  • func (p *STNPlugin) AfterInit() error
  • func (p *STNPlugin) Init() (err error)

Variables

var DefaultPlugin = *NewPlugin()

DefaultPlugin is a default instance of STN plugin.

Types

type Deps

type Deps struct {
	infra.PluginDeps
	KVScheduler kvs.KVScheduler
	VPP         govppmux.API
	IfPlugin    ifplugin.API
	StatusCheck statuscheck.PluginStatusWriter // optional
}

Deps lists dependencies of the STN plugin.

type Option

type Option func(*STNPlugin)

Option is a function that can be used in NewPlugin to customize Plugin.

func UseDeps

func UseDeps(f func(*Deps)) Option

UseDeps returns Option that can inject custom dependencies.

type STNPlugin

type STNPlugin struct {
	Deps
	// contains filtered or unexported fields
}

STNPlugin configures VPP STN rules using GoVPP.

func NewPlugin

func NewPlugin(opts ...Option) *STNPlugin

NewPlugin creates a new Plugin with the provided Options.

func (*STNPlugin) AfterInit

func (p *STNPlugin) AfterInit() error

AfterInit registers plugin with StatusCheck.

func (*STNPlugin) Init

func (p *STNPlugin) Init() (err error)

Init registers STN-related descriptors.