ifplugin

Documentation

Index

• Variables
• type API
• type Config
• type Deps
• type IfPlugin
  • func NewPlugin(opts ...Option) *IfPlugin
  • func (p *IfPlugin) Close() error
  • func (p *IfPlugin) GetInterfaceIndex() ifaceidx.LinuxIfMetadataIndex
  • func (p *IfPlugin) Init() error
  • func (p *IfPlugin) SetNotifyService(notify func(notification *linux.Notification))
• 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 {
	// GetInterfaceIndex gives read-only access to map with metadata of all configured
	// linux interfaces.
	GetInterfaceIndex() ifaceidx.LinuxIfMetadataIndex

	// SetNotifyService allows to pass function for updating interface notifications.
	SetNotifyService(notify func(notification *linux.Notification))
}

API defines methods exposed by Linux-IfPlugin.

type Config

type Config struct {
	Disabled      bool `json:"disabled"`
	GoRoutinesCnt int  `json:"go-routines-count"`
}

Config holds the ifplugin configuration.

type Deps

type Deps struct {
	infra.PluginDeps
	ServiceLabel servicelabel.ReaderAPI
	KVScheduler  kvs.KVScheduler
	NsPlugin     nsplugin.API
	AddrAlloc    netalloc.AddressAllocator
	VppIfPlugin  descriptor.VPPIfPluginAPI /* mandatory if TAP_TO_VPP interfaces are used */
}

Deps lists dependencies of the interface plugin.

type IfPlugin

type IfPlugin struct {
	Deps

	PushNotification func(notification *linux.Notification)
	// contains filtered or unexported fields
}

IfPlugin configures Linux VETH and TAP interfaces using Netlink API.

func NewPlugin

func NewPlugin(opts ...Option) *IfPlugin

NewPlugin creates a new Plugin with the provides Options

func (*IfPlugin) Close

func (p *IfPlugin) Close() error

Close stops watching of the default network namespace.

func (*IfPlugin) GetInterfaceIndex

func (p *IfPlugin) GetInterfaceIndex() ifaceidx.LinuxIfMetadataIndex

GetInterfaceIndex gives read-only access to map with metadata of all configured linux interfaces.

func (*IfPlugin) Init

func (p *IfPlugin) Init() error

Init registers interface-related descriptors and starts watching of the default network namespace for interface changes.

func (*IfPlugin) SetNotifyService

func (p *IfPlugin) SetNotifyService(notify func(notification *linux.Notification))

type Option

type Option func(*IfPlugin)

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.