descriptor

Documentation

Index

• Variables
• func NewBfdDescriptor(handler vppcalls.BfdVppAPI, log logging.PluginLogger) *kvs.KVDescriptor
• type BfdDescriptor
  • func (d *BfdDescriptor) Create(_ string, bfdEntry *bfd.BFD) (metadata interface{}, err error)
  • func (d *BfdDescriptor) Delete(_ string, bfdEntry *bfd.BFD, _ interface{}) error
  • func (d *BfdDescriptor) Dependencies(_ string, bfdEntry *bfd.BFD) []kvs.Dependency
  • func (d *BfdDescriptor) Retrieve(correlate []adapter.BfdKVWithMetadata) (dump []adapter.BfdKVWithMetadata, err error)
  • func (d *BfdDescriptor) Validate(_ string, bfdEntry *bfd.BFD) error

Variables

var (
	// ErrBfdIPAddressMissing is returned if the BFD has no local or peer IP address defined
	ErrBfdIPAddressMissing = errors.New("BFD: local or peer IP address is missing")

	// ErrBfdIPAddressInvalid is returned if local or peer IP address is malformed
	ErrBfdIPAddressInvalid = errors.New("BFD: local or peer IP addresses is invalid")

	// ErrBfdDetectMultiplierInvalid is returned if the detect multiplier is a null value
	ErrBfdDetectMultiplierInvalid = errors.New("BFD: detect multiplier must be non-zero value")
)

validation errors

Functions

func NewBfdDescriptor

func NewBfdDescriptor(handler vppcalls.BfdVppAPI, log logging.PluginLogger) *kvs.KVDescriptor

NewBfdDescriptor initializes BFD descriptor

Types

type BfdDescriptor

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

BfdDescriptor defines BFD session, model definition and validation

func (*BfdDescriptor) Create

func (d *BfdDescriptor) Create(_ string, bfdEntry *bfd.BFD) (metadata interface{}, err error)

Create add a new BFD session

func (*BfdDescriptor) Delete

func (d *BfdDescriptor) Delete(_ string, bfdEntry *bfd.BFD, _ interface{}) error

Delete existing BFD session

func (*BfdDescriptor) Dependencies

func (d *BfdDescriptor) Dependencies(_ string, bfdEntry *bfd.BFD) []kvs.Dependency

Dependencies define interface where the BFD session is attached on

func (*BfdDescriptor) Retrieve

func (d *BfdDescriptor) Retrieve(correlate []adapter.BfdKVWithMetadata) (dump []adapter.BfdKVWithMetadata, err error)

func (*BfdDescriptor) Validate

func (d *BfdDescriptor) Validate(_ string, bfdEntry *bfd.BFD) error

Validate BFD session IP addresses and detect multiplier value