vppcalls

Documentation

Index

• type PuntDetails
• type PuntVPPRead
• type PuntVPPWrite
• type PuntVppAPI
• type PuntVppHandler
  • func NewPuntVppHandler(callsChan api.Channel, mapping puntidx.PuntIndex, log logging.Logger) *PuntVppHandler
  • func (h *PuntVppHandler) DeregisterPuntSocket(puntCfg *punt.Punt) error
  • func (h *PuntVppHandler) DeregisterPuntSocketIPv6(puntCfg *punt.Punt) error
  • func (h *PuntVppHandler) DumpPuntRegisteredSockets() (punts []*PuntDetails)
  • func (h *PuntVppHandler) RegisterPuntSocket(puntCfg *punt.Punt) ([]byte, error)
  • func (h *PuntVppHandler) RegisterPuntSocketIPv6(puntCfg *punt.Punt) ([]byte, error)

Types

type PuntDetails

type PuntDetails struct {
	PuntData   *punt.Punt
	SocketPath []byte
}

PuntDetails includes proto-modelled punt object and its socket path

type PuntVPPRead

type PuntVPPRead interface {
	// DumpPuntRegisteredSockets returns all punt socket registrations known to the VPP agent
	// TODO since the API to dump sockets is missing, the method works only with the entries in local cache
	DumpPuntRegisteredSockets() (punts []*PuntDetails)
}

PuntVPPRead provides read methods for punt

type PuntVPPWrite

type PuntVPPWrite interface {
	// RegisterPuntSocket registers new punt to unix domain socket entry
	RegisterPuntSocket(puntCfg *punt.Punt) ([]byte, error)
	// DeregisterPuntSocket removes existing punt to socket registration
	DeregisterPuntSocket(puntCfg *punt.Punt) error
	// RegisterPuntSocketIPv6 registers new IPv6 punt to unix domain socket entry
	RegisterPuntSocketIPv6(puntCfg *punt.Punt) ([]byte, error)
	// DeregisterPuntSocketIPv6 removes existing IPv6 punt to socket registration
	DeregisterPuntSocketIPv6(puntCfg *punt.Punt) error
}

PuntVPPWrite provides write methods for punt

type PuntVppAPI

type PuntVppAPI interface {
	PuntVPPWrite
	PuntVPPRead
}

PuntVppAPI provides methods for managing VPP punt configuration.

type PuntVppHandler

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

PuntVppHandler is accessor for punt-related vppcalls methods.

func NewPuntVppHandler

func NewPuntVppHandler(callsChan api.Channel, mapping puntidx.PuntIndex, log logging.Logger) *PuntVppHandler

NewPuntVppHandler creates new instance of punt vppcalls handler

func (*PuntVppHandler) DeregisterPuntSocket

func (h *PuntVppHandler) DeregisterPuntSocket(puntCfg *punt.Punt) error

DeregisterPuntSocket removes existing punt to socket registration

func (*PuntVppHandler) DeregisterPuntSocketIPv6

func (h *PuntVppHandler) DeregisterPuntSocketIPv6(puntCfg *punt.Punt) error

DeregisterPuntSocketIPv6 removes existing IPv6 punt to socket registration

func (*PuntVppHandler) DumpPuntRegisteredSockets

func (h *PuntVppHandler) DumpPuntRegisteredSockets() (punts []*PuntDetails)

DumpPuntRegisteredSockets returns punt to host via registered socket entries TODO since the binary API is not available, all data are read from local cache for now

func (*PuntVppHandler) RegisterPuntSocket

func (h *PuntVppHandler) RegisterPuntSocket(puntCfg *punt.Punt) ([]byte, error)

RegisterPuntSocket registers new punt to socket

func (*PuntVppHandler) RegisterPuntSocketIPv6

func (h *PuntVppHandler) RegisterPuntSocketIPv6(puntCfg *punt.Punt) ([]byte, error)

RegisterPuntSocketIPv6 registers new IPv6 punt to socket