l3plugin

Documentation

Index

• Variables
• type API
• type Deps
• type L3Plugin
  • func NewPlugin(opts ...Option) *L3Plugin
  • func (p *L3Plugin) AfterInit() error
  • func (p *L3Plugin) GetVRFIndex() vrfidx.VRFMetadataIndex
  • func (p *L3Plugin) Init() error
• type Option
  • func UseDeps(f func(*Deps)) Option

Variables

var DefaultPlugin = *NewPlugin()

DefaultPlugin is a default instance of IfPlugin.

Types

type API

type API interface {
	// GetVRFIndex gives read-only access to map with metadata of all configured VPP VRFs.
	GetVRFIndex() vrfidx.VRFMetadataIndex
}

API defines methods exposed by VPP-L3Plugin.

type Deps

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

Deps lists dependencies of the interface p.

type L3Plugin

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

L3Plugin configures Linux routes and ARP entries using Netlink API.

func NewPlugin

func NewPlugin(opts ...Option) *L3Plugin

NewPlugin creates a new Plugin with the provides Options

func (*L3Plugin) AfterInit

func (p *L3Plugin) AfterInit() error

AfterInit registers plugin with StatusCheck.

func (*L3Plugin) GetVRFIndex

func (p *L3Plugin) GetVRFIndex() vrfidx.VRFMetadataIndex

GetVRFIndex gives read-only access to map with metadata of all configured VPP VRFs.

func (*L3Plugin) Init

func (p *L3Plugin) Init() error

Init initializes and registers descriptors for Linux ARPs and Routes.

type Option

type Option func(*L3Plugin)

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.