vpp

Documentation

Index

• Variables
• func GetHandlers() map[string]*Handler
• func Messages(funcs ...func() []govppapi.Message) binapi.MessagesList
• type Client
• type Handler
  • func RegisterHandler(hd HandlerDesc) *Handler
  • func (h *Handler) AddVersion(hv HandlerVersion)
  • func (h *Handler) FindCompatibleVersion(c Client) *HandlerVersion
  • func (h *Handler) GetCompatibleVersion(c Client) (*HandlerVersion, error)
  • func (h *Handler) Name() string
  • func (h *Handler) Versions() []Version
• type HandlerAPI
• type HandlerDesc
• type HandlerVersion
• type Version

Variables

var (
	// ErrIncompatible is an error returned when no compatible handler is found.
	ErrIncompatible = errors.New("incompatible handler")
	// ErrNoVersions is an error returned when no handler versions are found.
	ErrNoVersions = errors.New("no handler versions")
	// ErrPluginDisabled is an error returned when disabled plugin is detected.
	ErrPluginDisabled = errors.New("plugin not available")
)

Functions

func GetHandlers

func GetHandlers() map[string]*Handler

GetHandlers returns map for all registered handlers.

func Messages

func Messages(funcs ...func() []govppapi.Message) binapi.MessagesList

Types

type Client

type Client interface {
	binapi.CompatibilityChecker

	// NewAPIChannel returns new channel for sending binapi requests.
	NewAPIChannel() (govppapi.Channel, error)
	// Stats provides access to VPP stats API.
	Stats() govppapi.StatsProvider
	// IsPluginLoaded returns true if the given plugin is currently loaded.
	IsPluginLoaded(plugin string) bool
	// BinapiVersion returns preferred binapi version.
	BinapiVersion() Version
	// OnReconnect registers handler function to be executed on reconnect.
	OnReconnect(h func())
}

Client provides methods for managing VPP.

type Handler

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

Handler is a handler for managing implementations for multiple versions.

func RegisterHandler

func RegisterHandler(hd HandlerDesc) *Handler

RegisterHandler creates new handler described by handle descriptor.

func (*Handler) AddVersion

func (h *Handler) AddVersion(hv HandlerVersion)

AddVersion adds handler version to a list of available versions. Handler versions can be overwritten by calling AddVersion multiple times.

func (*Handler) FindCompatibleVersion

func (h *Handler) FindCompatibleVersion(c Client) *HandlerVersion

FindCompatibleVersion iterates over all available handler versions and calls their Check method to check compatibility.

func (*Handler) GetCompatibleVersion

func (h *Handler) GetCompatibleVersion(c Client) (*HandlerVersion, error)

GetCompatibleVersion iterates over all available handler versions and calls their Check method to check compatibility.

func (*Handler) Name

func (h *Handler) Name() string

func (*Handler) Versions

func (h *Handler) Versions() []Version

Versions returns list of versions from list of available handler versions.

type HandlerAPI

type HandlerAPI interface{}

HandlerAPI is an empty interface representing handler interface.

type HandlerDesc

type HandlerDesc struct {
	Name       string
	HandlerAPI interface{}
	NewFunc    interface{}
}

HandlerDesc represents a VPP handler's specification.

type HandlerVersion

type HandlerVersion struct {
	Version    Version
	Check      func(Client) error
	NewHandler func(Client, ...interface{}) HandlerAPI
	New        interface{}
}

HandlerVersion defines handler implementation for specific version used by AddVersion.

type Version

type Version = binapi.Version